Package grpc.gateway.protoc_gen_openapiv2.options

Interface Openapiv2.OperationOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Openapiv2.Operation, Openapiv2.Operation.Builder
    Enclosing class:
    Openapiv2
    public static interface Openapiv2.OperationOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsExtensions​(java.lang.String key)
      Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
      boolean containsResponses​(java.lang.String key)
      The list of possible responses as they are returned from executing this operation.
      java.lang.String getConsumes​(int index)
      A list of MIME types the operation can consume.
      com.google.protobuf.ByteString getConsumesBytes​(int index)
      A list of MIME types the operation can consume.
      int getConsumesCount()
      A list of MIME types the operation can consume.
      java.util.List<java.lang.String> getConsumesList()
      A list of MIME types the operation can consume.
      boolean getDeprecated()
      Declares this operation to be deprecated.
      java.lang.String getDescription()
      A verbose explanation of the operation behavior.
      com.google.protobuf.ByteString getDescriptionBytes()
      A verbose explanation of the operation behavior.
      java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensions()
      Deprecated.
      int getExtensionsCount()
      Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
      java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensionsMap()
      Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
      com.google.protobuf.Value getExtensionsOrDefault​(java.lang.String key, com.google.protobuf.Value defaultValue)
      Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
      com.google.protobuf.Value getExtensionsOrThrow​(java.lang.String key)
      Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
      Openapiv2.ExternalDocumentation getExternalDocs()
      Additional external documentation for this operation.
      Openapiv2.ExternalDocumentationOrBuilder getExternalDocsOrBuilder()
      Additional external documentation for this operation.
      java.lang.String getOperationId()
      Unique string used to identify the operation.
      com.google.protobuf.ByteString getOperationIdBytes()
      Unique string used to identify the operation.
      Openapiv2.Parameters getParameters()
      Custom parameters such as HTTP request headers.
      Openapiv2.ParametersOrBuilder getParametersOrBuilder()
      Custom parameters such as HTTP request headers.
      java.lang.String getProduces​(int index)
      A list of MIME types the operation can produce.
      com.google.protobuf.ByteString getProducesBytes​(int index)
      A list of MIME types the operation can produce.
      int getProducesCount()
      A list of MIME types the operation can produce.
      java.util.List<java.lang.String> getProducesList()
      A list of MIME types the operation can produce.
      java.util.Map<java.lang.String,​Openapiv2.Response> getResponses()
      Deprecated.
      int getResponsesCount()
      The list of possible responses as they are returned from executing this operation.
      java.util.Map<java.lang.String,​Openapiv2.Response> getResponsesMap()
      The list of possible responses as they are returned from executing this operation.
      Openapiv2.Response getResponsesOrDefault​(java.lang.String key, Openapiv2.Response defaultValue)
      The list of possible responses as they are returned from executing this operation.
      Openapiv2.Response getResponsesOrThrow​(java.lang.String key)
      The list of possible responses as they are returned from executing this operation.
      Openapiv2.Scheme getSchemes​(int index)
      The transfer protocol for the operation.
      int getSchemesCount()
      The transfer protocol for the operation.
      java.util.List<Openapiv2.Scheme> getSchemesList()
      The transfer protocol for the operation.
      int getSchemesValue​(int index)
      The transfer protocol for the operation.
      java.util.List<java.lang.Integer> getSchemesValueList()
      The transfer protocol for the operation.
      Openapiv2.SecurityRequirement getSecurity​(int index)
      A declaration of which security schemes are applied for this operation.
      int getSecurityCount()
      A declaration of which security schemes are applied for this operation.
      java.util.List<Openapiv2.SecurityRequirement> getSecurityList()
      A declaration of which security schemes are applied for this operation.
      Openapiv2.SecurityRequirementOrBuilder getSecurityOrBuilder​(int index)
      A declaration of which security schemes are applied for this operation.
      java.util.List<? extends Openapiv2.SecurityRequirementOrBuilder> getSecurityOrBuilderList()
      A declaration of which security schemes are applied for this operation.
      java.lang.String getSummary()
      A short summary of what the operation does.
      com.google.protobuf.ByteString getSummaryBytes()
      A short summary of what the operation does.
      java.lang.String getTags​(int index)
      A list of tags for API documentation control.
      com.google.protobuf.ByteString getTagsBytes​(int index)
      A list of tags for API documentation control.
      int getTagsCount()
      A list of tags for API documentation control.
      java.util.List<java.lang.String> getTagsList()
      A list of tags for API documentation control.
      boolean hasExternalDocs()
      Additional external documentation for this operation.
      boolean hasParameters()
      Custom parameters such as HTTP request headers.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getTagsList

        java.util.List<java.lang.String> getTagsList()
         A list of tags for API documentation control. Tags can be used for logical
 grouping of operations by resources or any other qualifier.
        repeated string tags = 1;
        Returns:
        A list containing the tags.

      • getTagsCount

        int getTagsCount()
         A list of tags for API documentation control. Tags can be used for logical
 grouping of operations by resources or any other qualifier.
        repeated string tags = 1;
        Returns:
        The count of tags.

      • getTags

        java.lang.String getTags​(int index)
         A list of tags for API documentation control. Tags can be used for logical
 grouping of operations by resources or any other qualifier.
        repeated string tags = 1;
        Parameters:
        index - The index of the element to return.
        Returns:
        The tags at the given index.

      • getTagsBytes

        com.google.protobuf.ByteString getTagsBytes​(int index)
         A list of tags for API documentation control. Tags can be used for logical
 grouping of operations by resources or any other qualifier.
        repeated string tags = 1;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the tags at the given index.

      • getSummary

        java.lang.String getSummary()
         A short summary of what the operation does. For maximum readability in the
 swagger-ui, this field SHOULD be less than 120 characters.
        string summary = 2;
        Returns:
        The summary.

      • getSummaryBytes

        com.google.protobuf.ByteString getSummaryBytes()
         A short summary of what the operation does. For maximum readability in the
 swagger-ui, this field SHOULD be less than 120 characters.
        string summary = 2;
        Returns:
        The bytes for summary.

      • getDescription

        java.lang.String getDescription()
         A verbose explanation of the operation behavior. GFM syntax can be used for
 rich text representation.
        string description = 3;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         A verbose explanation of the operation behavior. GFM syntax can be used for
 rich text representation.
        string description = 3;
        Returns:
        The bytes for description.

      • hasExternalDocs

        boolean hasExternalDocs()
         Additional external documentation for this operation.
        .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;
        Returns:
        Whether the externalDocs field is set.

      • getExternalDocs

        Openapiv2.ExternalDocumentation getExternalDocs()
         Additional external documentation for this operation.
        .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;
        Returns:
        The externalDocs.

      • getExternalDocsOrBuilder

        Openapiv2.ExternalDocumentationOrBuilder getExternalDocsOrBuilder()
         Additional external documentation for this operation.
        .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;

      • getOperationId

        java.lang.String getOperationId()
         Unique string used to identify the operation. The id MUST be unique among
 all operations described in the API. Tools and libraries MAY use the
 operationId to uniquely identify an operation, therefore, it is recommended
 to follow common programming naming conventions.
        string operation_id = 5;
        Returns:
        The operationId.

      • getOperationIdBytes

        com.google.protobuf.ByteString getOperationIdBytes()
         Unique string used to identify the operation. The id MUST be unique among
 all operations described in the API. Tools and libraries MAY use the
 operationId to uniquely identify an operation, therefore, it is recommended
 to follow common programming naming conventions.
        string operation_id = 5;
        Returns:
        The bytes for operationId.

      • getConsumesList

        java.util.List<java.lang.String> getConsumesList()
         A list of MIME types the operation can consume. This overrides the consumes
 definition at the OpenAPI Object. An empty value MAY be used to clear the
 global definition. Value MUST be as described under Mime Types.
        repeated string consumes = 6;
        Returns:
        A list containing the consumes.

      • getConsumesCount

        int getConsumesCount()
         A list of MIME types the operation can consume. This overrides the consumes
 definition at the OpenAPI Object. An empty value MAY be used to clear the
 global definition. Value MUST be as described under Mime Types.
        repeated string consumes = 6;
        Returns:
        The count of consumes.

      • getConsumes

        java.lang.String getConsumes​(int index)
         A list of MIME types the operation can consume. This overrides the consumes
 definition at the OpenAPI Object. An empty value MAY be used to clear the
 global definition. Value MUST be as described under Mime Types.
        repeated string consumes = 6;
        Parameters:
        index - The index of the element to return.
        Returns:
        The consumes at the given index.

      • getConsumesBytes

        com.google.protobuf.ByteString getConsumesBytes​(int index)
         A list of MIME types the operation can consume. This overrides the consumes
 definition at the OpenAPI Object. An empty value MAY be used to clear the
 global definition. Value MUST be as described under Mime Types.
        repeated string consumes = 6;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the consumes at the given index.

      • getProducesList

        java.util.List<java.lang.String> getProducesList()
         A list of MIME types the operation can produce. This overrides the produces
 definition at the OpenAPI Object. An empty value MAY be used to clear the
 global definition. Value MUST be as described under Mime Types.
        repeated string produces = 7;
        Returns:
        A list containing the produces.

      • getProducesCount

        int getProducesCount()
         A list of MIME types the operation can produce. This overrides the produces
 definition at the OpenAPI Object. An empty value MAY be used to clear the
 global definition. Value MUST be as described under Mime Types.
        repeated string produces = 7;
        Returns:
        The count of produces.

      • getProduces

        java.lang.String getProduces​(int index)
         A list of MIME types the operation can produce. This overrides the produces
 definition at the OpenAPI Object. An empty value MAY be used to clear the
 global definition. Value MUST be as described under Mime Types.
        repeated string produces = 7;
        Parameters:
        index - The index of the element to return.
        Returns:
        The produces at the given index.

      • getProducesBytes

        com.google.protobuf.ByteString getProducesBytes​(int index)
         A list of MIME types the operation can produce. This overrides the produces
 definition at the OpenAPI Object. An empty value MAY be used to clear the
 global definition. Value MUST be as described under Mime Types.
        repeated string produces = 7;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the produces at the given index.

      • getResponsesCount

        int getResponsesCount()
         The list of possible responses as they are returned from executing this
 operation.
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;

      • containsResponses

        boolean containsResponses​(java.lang.String key)
         The list of possible responses as they are returned from executing this
 operation.
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;

      • getResponsesMap

        java.util.Map<java.lang.String,​Openapiv2.Response> getResponsesMap()
         The list of possible responses as they are returned from executing this
 operation.
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;

      • getResponsesOrDefault

        Openapiv2.Response getResponsesOrDefault​(java.lang.String key,
                                         Openapiv2.Response defaultValue)
         The list of possible responses as they are returned from executing this
 operation.
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;

      • getResponsesOrThrow

        Openapiv2.Response getResponsesOrThrow​(java.lang.String key)
         The list of possible responses as they are returned from executing this
 operation.
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;

      • getSchemesList

        java.util.List<Openapiv2.Scheme> getSchemesList()
         The transfer protocol for the operation. Values MUST be from the list:
 "http", "https", "ws", "wss". The value overrides the OpenAPI Object
 schemes definition.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;
        Returns:
        A list containing the schemes.

      • getSchemesCount

        int getSchemesCount()
         The transfer protocol for the operation. Values MUST be from the list:
 "http", "https", "ws", "wss". The value overrides the OpenAPI Object
 schemes definition.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;
        Returns:
        The count of schemes.

      • getSchemes

        Openapiv2.Scheme getSchemes​(int index)
         The transfer protocol for the operation. Values MUST be from the list:
 "http", "https", "ws", "wss". The value overrides the OpenAPI Object
 schemes definition.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;
        Parameters:
        index - The index of the element to return.
        Returns:
        The schemes at the given index.

      • getSchemesValueList

        java.util.List<java.lang.Integer> getSchemesValueList()
         The transfer protocol for the operation. Values MUST be from the list:
 "http", "https", "ws", "wss". The value overrides the OpenAPI Object
 schemes definition.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;
        Returns:
        A list containing the enum numeric values on the wire for schemes.

      • getSchemesValue

        int getSchemesValue​(int index)
         The transfer protocol for the operation. Values MUST be from the list:
 "http", "https", "ws", "wss". The value overrides the OpenAPI Object
 schemes definition.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of schemes at the given index.

      • getDeprecated

        boolean getDeprecated()
         Declares this operation to be deprecated. Usage of the declared operation
 should be refrained. Default value is false.
        bool deprecated = 11;
        Returns:
        The deprecated.

      • getSecurityList

        java.util.List<Openapiv2.SecurityRequirement> getSecurityList()
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • getSecurity

        Openapiv2.SecurityRequirement getSecurity​(int index)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • getSecurityCount

        int getSecurityCount()
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • getSecurityOrBuilderList

        java.util.List<? extends Openapiv2.SecurityRequirementOrBuilder> getSecurityOrBuilderList()
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • getSecurityOrBuilder

        Openapiv2.SecurityRequirementOrBuilder getSecurityOrBuilder​(int index)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • getExtensionsCount

        int getExtensionsCount()
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;

      • containsExtensions

        boolean containsExtensions​(java.lang.String key)
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;

      • getExtensions

        @Deprecated
java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensions()
        Deprecated.
        Use getExtensionsMap() instead.

      • getExtensionsMap

        java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensionsMap()
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;

      • getExtensionsOrDefault

        com.google.protobuf.Value getExtensionsOrDefault​(java.lang.String key,
                                                 com.google.protobuf.Value defaultValue)
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;

      • getExtensionsOrThrow

        com.google.protobuf.Value getExtensionsOrThrow​(java.lang.String key)
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;

      • hasParameters

        boolean hasParameters()
         Custom parameters such as HTTP request headers.
 See: https://swagger.io/docs/specification/2-0/describing-parameters/
 and https://swagger.io/specification/v2/#parameter-object.
        .grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;
        Returns:
        Whether the parameters field is set.

      • getParameters

        Openapiv2.Parameters getParameters()
         Custom parameters such as HTTP request headers.
 See: https://swagger.io/docs/specification/2-0/describing-parameters/
 and https://swagger.io/specification/v2/#parameter-object.
        .grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;
        Returns:
        The parameters.

      • getParametersOrBuilder

        Openapiv2.ParametersOrBuilder getParametersOrBuilder()
         Custom parameters such as HTTP request headers.
 See: https://swagger.io/docs/specification/2-0/describing-parameters/
 and https://swagger.io/specification/v2/#parameter-object.
        .grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;