Class Openapiv2.Swagger.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
- grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Swagger.Builder
-
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Openapiv2.SwaggerOrBuilder,java.lang.Cloneable
- Enclosing class:
- Openapiv2.Swagger
public static final class Openapiv2.Swagger.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder> implements Openapiv2.SwaggerOrBuilder
`Swagger` is a representation of OpenAPI v2 specification's Swagger object. See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject Example: option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { info: { title: "Echo API"; version: "1.0"; description: ""; contact: { name: "gRPC-Gateway project"; url: "https://github.com/grpc-ecosystem/grpc-gateway"; email: "none@example.com"; }; license: { name: "BSD 3-Clause License"; url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE.txt"; }; }; schemes: HTTPS; consumes: "application/json"; produces: "application/json"; };Protobuf typegrpc.gateway.protoc_gen_openapiv2.options.Swagger
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Openapiv2.Swagger.BuilderaddAllConsumes(java.lang.Iterable<java.lang.String> values)A list of MIME types the APIs can consume.Openapiv2.Swagger.BuilderaddAllProduces(java.lang.Iterable<java.lang.String> values)A list of MIME types the APIs can produce.Openapiv2.Swagger.BuilderaddAllSchemes(java.lang.Iterable<? extends Openapiv2.Scheme> values)The transfer protocol of the API.Openapiv2.Swagger.BuilderaddAllSchemesValue(java.lang.Iterable<java.lang.Integer> values)The transfer protocol of the API.Openapiv2.Swagger.BuilderaddAllSecurity(java.lang.Iterable<? extends Openapiv2.SecurityRequirement> values)A declaration of which security schemes are applied for the API as a whole.Openapiv2.Swagger.BuilderaddAllTags(java.lang.Iterable<? extends Openapiv2.Tag> values)A list of tags for API documentation control.Openapiv2.Swagger.BuilderaddConsumes(java.lang.String value)A list of MIME types the APIs can consume.Openapiv2.Swagger.BuilderaddConsumesBytes(com.google.protobuf.ByteString value)A list of MIME types the APIs can consume.Openapiv2.Swagger.BuilderaddProduces(java.lang.String value)A list of MIME types the APIs can produce.Openapiv2.Swagger.BuilderaddProducesBytes(com.google.protobuf.ByteString value)A list of MIME types the APIs can produce.Openapiv2.Swagger.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)Openapiv2.Swagger.BuilderaddSchemes(Openapiv2.Scheme value)The transfer protocol of the API.Openapiv2.Swagger.BuilderaddSchemesValue(int value)The transfer protocol of the API.Openapiv2.Swagger.BuilderaddSecurity(int index, Openapiv2.SecurityRequirement value)A declaration of which security schemes are applied for the API as a whole.Openapiv2.Swagger.BuilderaddSecurity(int index, Openapiv2.SecurityRequirement.Builder builderForValue)A declaration of which security schemes are applied for the API as a whole.Openapiv2.Swagger.BuilderaddSecurity(Openapiv2.SecurityRequirement value)A declaration of which security schemes are applied for the API as a whole.Openapiv2.Swagger.BuilderaddSecurity(Openapiv2.SecurityRequirement.Builder builderForValue)A declaration of which security schemes are applied for the API as a whole.Openapiv2.SecurityRequirement.BuilderaddSecurityBuilder()A declaration of which security schemes are applied for the API as a whole.Openapiv2.SecurityRequirement.BuilderaddSecurityBuilder(int index)A declaration of which security schemes are applied for the API as a whole.Openapiv2.Swagger.BuilderaddTags(int index, Openapiv2.Tag value)A list of tags for API documentation control.Openapiv2.Swagger.BuilderaddTags(int index, Openapiv2.Tag.Builder builderForValue)A list of tags for API documentation control.Openapiv2.Swagger.BuilderaddTags(Openapiv2.Tag value)A list of tags for API documentation control.Openapiv2.Swagger.BuilderaddTags(Openapiv2.Tag.Builder builderForValue)A list of tags for API documentation control.Openapiv2.Tag.BuilderaddTagsBuilder()A list of tags for API documentation control.Openapiv2.Tag.BuilderaddTagsBuilder(int index)A list of tags for API documentation control.Openapiv2.Swaggerbuild()Openapiv2.SwaggerbuildPartial()Openapiv2.Swagger.Builderclear()Openapiv2.Swagger.BuilderclearBasePath()The base path on which the API is served, which is relative to the host.Openapiv2.Swagger.BuilderclearConsumes()A list of MIME types the APIs can consume.Openapiv2.Swagger.BuilderclearExtensions()Openapiv2.Swagger.BuilderclearExternalDocs()Additional external documentation.Openapiv2.Swagger.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)Openapiv2.Swagger.BuilderclearHost()The host (name or ip) serving the API.Openapiv2.Swagger.BuilderclearInfo()Provides metadata about the API.Openapiv2.Swagger.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)Openapiv2.Swagger.BuilderclearProduces()A list of MIME types the APIs can produce.Openapiv2.Swagger.BuilderclearResponses()Openapiv2.Swagger.BuilderclearSchemes()The transfer protocol of the API.Openapiv2.Swagger.BuilderclearSecurity()A declaration of which security schemes are applied for the API as a whole.Openapiv2.Swagger.BuilderclearSecurityDefinitions()Security scheme definitions that can be used across the specification.Openapiv2.Swagger.BuilderclearSwagger()Specifies the OpenAPI Specification version being used.Openapiv2.Swagger.BuilderclearTags()A list of tags for API documentation control.Openapiv2.Swagger.Builderclone()booleancontainsExtensions(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.booleancontainsResponses(java.lang.String key)An object to hold responses that can be used across operations.java.lang.StringgetBasePath()The base path on which the API is served, which is relative to the host.com.google.protobuf.ByteStringgetBasePathBytes()The base path on which the API is served, which is relative to the host.java.lang.StringgetConsumes(int index)A list of MIME types the APIs can consume.com.google.protobuf.ByteStringgetConsumesBytes(int index)A list of MIME types the APIs can consume.intgetConsumesCount()A list of MIME types the APIs can consume.com.google.protobuf.ProtocolStringListgetConsumesList()A list of MIME types the APIs can consume.Openapiv2.SwaggergetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()java.util.Map<java.lang.String,com.google.protobuf.Value>getExtensions()Deprecated.intgetExtensionsCount()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.ValuegetExtensionsOrDefault(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.ValuegetExtensionsOrThrow(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.ExternalDocumentationgetExternalDocs()Additional external documentation.Openapiv2.ExternalDocumentation.BuildergetExternalDocsBuilder()Additional external documentation.Openapiv2.ExternalDocumentationOrBuildergetExternalDocsOrBuilder()Additional external documentation.java.lang.StringgetHost()The host (name or ip) serving the API.com.google.protobuf.ByteStringgetHostBytes()The host (name or ip) serving the API.Openapiv2.InfogetInfo()Provides metadata about the API.Openapiv2.Info.BuildergetInfoBuilder()Provides metadata about the API.Openapiv2.InfoOrBuildergetInfoOrBuilder()Provides metadata about the API.java.util.Map<java.lang.String,com.google.protobuf.Value>getMutableExtensions()Deprecated.java.util.Map<java.lang.String,Openapiv2.Response>getMutableResponses()Deprecated.java.lang.StringgetProduces(int index)A list of MIME types the APIs can produce.com.google.protobuf.ByteStringgetProducesBytes(int index)A list of MIME types the APIs can produce.intgetProducesCount()A list of MIME types the APIs can produce.com.google.protobuf.ProtocolStringListgetProducesList()A list of MIME types the APIs can produce.java.util.Map<java.lang.String,Openapiv2.Response>getResponses()Deprecated.intgetResponsesCount()An object to hold responses that can be used across operations.java.util.Map<java.lang.String,Openapiv2.Response>getResponsesMap()An object to hold responses that can be used across operations.Openapiv2.ResponsegetResponsesOrDefault(java.lang.String key, Openapiv2.Response defaultValue)An object to hold responses that can be used across operations.Openapiv2.ResponsegetResponsesOrThrow(java.lang.String key)An object to hold responses that can be used across operations.Openapiv2.SchemegetSchemes(int index)The transfer protocol of the API.intgetSchemesCount()The transfer protocol of the API.java.util.List<Openapiv2.Scheme>getSchemesList()The transfer protocol of the API.intgetSchemesValue(int index)The transfer protocol of the API.java.util.List<java.lang.Integer>getSchemesValueList()The transfer protocol of the API.Openapiv2.SecurityRequirementgetSecurity(int index)A declaration of which security schemes are applied for the API as a whole.Openapiv2.SecurityRequirement.BuildergetSecurityBuilder(int index)A declaration of which security schemes are applied for the API as a whole.java.util.List<Openapiv2.SecurityRequirement.Builder>getSecurityBuilderList()A declaration of which security schemes are applied for the API as a whole.intgetSecurityCount()A declaration of which security schemes are applied for the API as a whole.Openapiv2.SecurityDefinitionsgetSecurityDefinitions()Security scheme definitions that can be used across the specification.Openapiv2.SecurityDefinitions.BuildergetSecurityDefinitionsBuilder()Security scheme definitions that can be used across the specification.Openapiv2.SecurityDefinitionsOrBuildergetSecurityDefinitionsOrBuilder()Security scheme definitions that can be used across the specification.java.util.List<Openapiv2.SecurityRequirement>getSecurityList()A declaration of which security schemes are applied for the API as a whole.Openapiv2.SecurityRequirementOrBuildergetSecurityOrBuilder(int index)A declaration of which security schemes are applied for the API as a whole.java.util.List<? extends Openapiv2.SecurityRequirementOrBuilder>getSecurityOrBuilderList()A declaration of which security schemes are applied for the API as a whole.java.lang.StringgetSwagger()Specifies the OpenAPI Specification version being used.com.google.protobuf.ByteStringgetSwaggerBytes()Specifies the OpenAPI Specification version being used.Openapiv2.TaggetTags(int index)A list of tags for API documentation control.Openapiv2.Tag.BuildergetTagsBuilder(int index)A list of tags for API documentation control.java.util.List<Openapiv2.Tag.Builder>getTagsBuilderList()A list of tags for API documentation control.intgetTagsCount()A list of tags for API documentation control.java.util.List<Openapiv2.Tag>getTagsList()A list of tags for API documentation control.Openapiv2.TagOrBuildergetTagsOrBuilder(int index)A list of tags for API documentation control.java.util.List<? extends Openapiv2.TagOrBuilder>getTagsOrBuilderList()A list of tags for API documentation control.booleanhasExternalDocs()Additional external documentation.booleanhasInfo()Provides metadata about the API.booleanhasSecurityDefinitions()Security scheme definitions that can be used across the specification.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)protected com.google.protobuf.MapFieldinternalGetMutableMapField(int number)booleanisInitialized()Openapiv2.Swagger.BuildermergeExternalDocs(Openapiv2.ExternalDocumentation value)Additional external documentation.Openapiv2.Swagger.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)Openapiv2.Swagger.BuildermergeFrom(com.google.protobuf.Message other)Openapiv2.Swagger.BuildermergeFrom(Openapiv2.Swagger other)Openapiv2.Swagger.BuildermergeInfo(Openapiv2.Info value)Provides metadata about the API.Openapiv2.Swagger.BuildermergeSecurityDefinitions(Openapiv2.SecurityDefinitions value)Security scheme definitions that can be used across the specification.Openapiv2.Swagger.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)Openapiv2.Swagger.BuilderputAllExtensions(java.util.Map<java.lang.String,com.google.protobuf.Value> values)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.Swagger.BuilderputAllResponses(java.util.Map<java.lang.String,Openapiv2.Response> values)An object to hold responses that can be used across operations.Openapiv2.Swagger.BuilderputExtensions(java.lang.String key, com.google.protobuf.Value value)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.Swagger.BuilderputResponses(java.lang.String key, Openapiv2.Response value)An object to hold responses that can be used across operations.Openapiv2.Swagger.BuilderremoveExtensions(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.Swagger.BuilderremoveResponses(java.lang.String key)An object to hold responses that can be used across operations.Openapiv2.Swagger.BuilderremoveSecurity(int index)A declaration of which security schemes are applied for the API as a whole.Openapiv2.Swagger.BuilderremoveTags(int index)A list of tags for API documentation control.Openapiv2.Swagger.BuildersetBasePath(java.lang.String value)The base path on which the API is served, which is relative to the host.Openapiv2.Swagger.BuildersetBasePathBytes(com.google.protobuf.ByteString value)The base path on which the API is served, which is relative to the host.Openapiv2.Swagger.BuildersetConsumes(int index, java.lang.String value)A list of MIME types the APIs can consume.Openapiv2.Swagger.BuildersetExternalDocs(Openapiv2.ExternalDocumentation value)Additional external documentation.Openapiv2.Swagger.BuildersetExternalDocs(Openapiv2.ExternalDocumentation.Builder builderForValue)Additional external documentation.Openapiv2.Swagger.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)Openapiv2.Swagger.BuildersetHost(java.lang.String value)The host (name or ip) serving the API.Openapiv2.Swagger.BuildersetHostBytes(com.google.protobuf.ByteString value)The host (name or ip) serving the API.Openapiv2.Swagger.BuildersetInfo(Openapiv2.Info value)Provides metadata about the API.Openapiv2.Swagger.BuildersetInfo(Openapiv2.Info.Builder builderForValue)Provides metadata about the API.Openapiv2.Swagger.BuildersetProduces(int index, java.lang.String value)A list of MIME types the APIs can produce.Openapiv2.Swagger.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)Openapiv2.Swagger.BuildersetSchemes(int index, Openapiv2.Scheme value)The transfer protocol of the API.Openapiv2.Swagger.BuildersetSchemesValue(int index, int value)The transfer protocol of the API.Openapiv2.Swagger.BuildersetSecurity(int index, Openapiv2.SecurityRequirement value)A declaration of which security schemes are applied for the API as a whole.Openapiv2.Swagger.BuildersetSecurity(int index, Openapiv2.SecurityRequirement.Builder builderForValue)A declaration of which security schemes are applied for the API as a whole.Openapiv2.Swagger.BuildersetSecurityDefinitions(Openapiv2.SecurityDefinitions value)Security scheme definitions that can be used across the specification.Openapiv2.Swagger.BuildersetSecurityDefinitions(Openapiv2.SecurityDefinitions.Builder builderForValue)Security scheme definitions that can be used across the specification.Openapiv2.Swagger.BuildersetSwagger(java.lang.String value)Specifies the OpenAPI Specification version being used.Openapiv2.Swagger.BuildersetSwaggerBytes(com.google.protobuf.ByteString value)Specifies the OpenAPI Specification version being used.Openapiv2.Swagger.BuildersetTags(int index, Openapiv2.Tag value)A list of tags for API documentation control.Openapiv2.Swagger.BuildersetTags(int index, Openapiv2.Tag.Builder builderForValue)A list of tags for API documentation control.Openapiv2.Swagger.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
internalGetMutableMapField
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
- Overrides:
internalGetMutableMapFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
clear
public Openapiv2.Swagger.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
getDefaultInstanceForType
public Openapiv2.Swagger getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public Openapiv2.Swagger build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public Openapiv2.Swagger buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public Openapiv2.Swagger.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
setField
public Openapiv2.Swagger.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
clearField
public Openapiv2.Swagger.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
clearOneof
public Openapiv2.Swagger.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
setRepeatedField
public Openapiv2.Swagger.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
addRepeatedField
public Openapiv2.Swagger.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
mergeFrom
public Openapiv2.Swagger.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Openapiv2.Swagger.Builder>
-
mergeFrom
public Openapiv2.Swagger.Builder mergeFrom(Openapiv2.Swagger other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
mergeFrom
public Openapiv2.Swagger.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Openapiv2.Swagger.Builder>- Throws:
java.io.IOException
-
getSwagger
public java.lang.String getSwagger()
Specifies the OpenAPI Specification version being used. It can be used by the OpenAPI UI and other clients to interpret the API listing. The value MUST be "2.0".
string swagger = 1;- Specified by:
getSwaggerin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The swagger.
-
getSwaggerBytes
public com.google.protobuf.ByteString getSwaggerBytes()
Specifies the OpenAPI Specification version being used. It can be used by the OpenAPI UI and other clients to interpret the API listing. The value MUST be "2.0".
string swagger = 1;- Specified by:
getSwaggerBytesin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The bytes for swagger.
-
setSwagger
public Openapiv2.Swagger.Builder setSwagger(java.lang.String value)
Specifies the OpenAPI Specification version being used. It can be used by the OpenAPI UI and other clients to interpret the API listing. The value MUST be "2.0".
string swagger = 1;- Parameters:
value- The swagger to set.- Returns:
- This builder for chaining.
-
clearSwagger
public Openapiv2.Swagger.Builder clearSwagger()
Specifies the OpenAPI Specification version being used. It can be used by the OpenAPI UI and other clients to interpret the API listing. The value MUST be "2.0".
string swagger = 1;- Returns:
- This builder for chaining.
-
setSwaggerBytes
public Openapiv2.Swagger.Builder setSwaggerBytes(com.google.protobuf.ByteString value)
Specifies the OpenAPI Specification version being used. It can be used by the OpenAPI UI and other clients to interpret the API listing. The value MUST be "2.0".
string swagger = 1;- Parameters:
value- The bytes for swagger to set.- Returns:
- This builder for chaining.
-
hasInfo
public boolean hasInfo()
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;- Specified by:
hasInfoin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- Whether the info field is set.
-
getInfo
public Openapiv2.Info getInfo()
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;- Specified by:
getInfoin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The info.
-
setInfo
public Openapiv2.Swagger.Builder setInfo(Openapiv2.Info value)
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
-
setInfo
public Openapiv2.Swagger.Builder setInfo(Openapiv2.Info.Builder builderForValue)
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
-
mergeInfo
public Openapiv2.Swagger.Builder mergeInfo(Openapiv2.Info value)
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
-
clearInfo
public Openapiv2.Swagger.Builder clearInfo()
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
-
getInfoBuilder
public Openapiv2.Info.Builder getInfoBuilder()
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
-
getInfoOrBuilder
public Openapiv2.InfoOrBuilder getInfoOrBuilder()
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;- Specified by:
getInfoOrBuilderin interfaceOpenapiv2.SwaggerOrBuilder
-
getHost
public java.lang.String getHost()
The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.
string host = 3;- Specified by:
getHostin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The host.
-
getHostBytes
public com.google.protobuf.ByteString getHostBytes()
The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.
string host = 3;- Specified by:
getHostBytesin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The bytes for host.
-
setHost
public Openapiv2.Swagger.Builder setHost(java.lang.String value)
The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.
string host = 3;- Parameters:
value- The host to set.- Returns:
- This builder for chaining.
-
clearHost
public Openapiv2.Swagger.Builder clearHost()
The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.
string host = 3;- Returns:
- This builder for chaining.
-
setHostBytes
public Openapiv2.Swagger.Builder setHostBytes(com.google.protobuf.ByteString value)
The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.
string host = 3;- Parameters:
value- The bytes for host to set.- Returns:
- This builder for chaining.
-
getBasePath
public java.lang.String getBasePath()
The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating. Note that using `base_path` does not change the endpoint paths that are generated in the resulting OpenAPI file. If you wish to use `base_path` with relatively generated OpenAPI paths, the `base_path` prefix must be manually removed from your `google.api.http` paths and your code changed to serve the API from the `base_path`.
string base_path = 4;- Specified by:
getBasePathin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The basePath.
-
getBasePathBytes
public com.google.protobuf.ByteString getBasePathBytes()
The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating. Note that using `base_path` does not change the endpoint paths that are generated in the resulting OpenAPI file. If you wish to use `base_path` with relatively generated OpenAPI paths, the `base_path` prefix must be manually removed from your `google.api.http` paths and your code changed to serve the API from the `base_path`.
string base_path = 4;- Specified by:
getBasePathBytesin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The bytes for basePath.
-
setBasePath
public Openapiv2.Swagger.Builder setBasePath(java.lang.String value)
The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating. Note that using `base_path` does not change the endpoint paths that are generated in the resulting OpenAPI file. If you wish to use `base_path` with relatively generated OpenAPI paths, the `base_path` prefix must be manually removed from your `google.api.http` paths and your code changed to serve the API from the `base_path`.
string base_path = 4;- Parameters:
value- The basePath to set.- Returns:
- This builder for chaining.
-
clearBasePath
public Openapiv2.Swagger.Builder clearBasePath()
The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating. Note that using `base_path` does not change the endpoint paths that are generated in the resulting OpenAPI file. If you wish to use `base_path` with relatively generated OpenAPI paths, the `base_path` prefix must be manually removed from your `google.api.http` paths and your code changed to serve the API from the `base_path`.
string base_path = 4;- Returns:
- This builder for chaining.
-
setBasePathBytes
public Openapiv2.Swagger.Builder setBasePathBytes(com.google.protobuf.ByteString value)
The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating. Note that using `base_path` does not change the endpoint paths that are generated in the resulting OpenAPI file. If you wish to use `base_path` with relatively generated OpenAPI paths, the `base_path` prefix must be manually removed from your `google.api.http` paths and your code changed to serve the API from the `base_path`.
string base_path = 4;- Parameters:
value- The bytes for basePath to set.- Returns:
- This builder for chaining.
-
getSchemesList
public java.util.List<Openapiv2.Scheme> getSchemesList()
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;- Specified by:
getSchemesListin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- A list containing the schemes.
-
getSchemesCount
public int getSchemesCount()
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;- Specified by:
getSchemesCountin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The count of schemes.
-
getSchemes
public Openapiv2.Scheme getSchemes(int index)
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;- Specified by:
getSchemesin interfaceOpenapiv2.SwaggerOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The schemes at the given index.
-
setSchemes
public Openapiv2.Swagger.Builder setSchemes(int index, Openapiv2.Scheme value)
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;- Parameters:
index- The index to set the value at.value- The schemes to set.- Returns:
- This builder for chaining.
-
addSchemes
public Openapiv2.Swagger.Builder addSchemes(Openapiv2.Scheme value)
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;- Parameters:
value- The schemes to add.- Returns:
- This builder for chaining.
-
addAllSchemes
public Openapiv2.Swagger.Builder addAllSchemes(java.lang.Iterable<? extends Openapiv2.Scheme> values)
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;- Parameters:
values- The schemes to add.- Returns:
- This builder for chaining.
-
clearSchemes
public Openapiv2.Swagger.Builder clearSchemes()
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;- Returns:
- This builder for chaining.
-
getSchemesValueList
public java.util.List<java.lang.Integer> getSchemesValueList()
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;- Specified by:
getSchemesValueListin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- A list containing the enum numeric values on the wire for schemes.
-
getSchemesValue
public int getSchemesValue(int index)
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;- Specified by:
getSchemesValuein interfaceOpenapiv2.SwaggerOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of schemes at the given index.
-
setSchemesValue
public Openapiv2.Swagger.Builder setSchemesValue(int index, int value)
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;- Parameters:
index- The index to set the value at.value- The enum numeric value on the wire for schemes to set.- Returns:
- This builder for chaining.
-
addSchemesValue
public Openapiv2.Swagger.Builder addSchemesValue(int value)
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;- Parameters:
value- The enum numeric value on the wire for schemes to add.- Returns:
- This builder for chaining.
-
addAllSchemesValue
public Openapiv2.Swagger.Builder addAllSchemesValue(java.lang.Iterable<java.lang.Integer> values)
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;- Parameters:
values- The enum numeric values on the wire for schemes to add.- Returns:
- This builder for chaining.
-
getConsumesList
public com.google.protobuf.ProtocolStringList getConsumesList()
A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Specified by:
getConsumesListin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- A list containing the consumes.
-
getConsumesCount
public int getConsumesCount()
A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Specified by:
getConsumesCountin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The count of consumes.
-
getConsumes
public java.lang.String getConsumes(int index)
A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Specified by:
getConsumesin interfaceOpenapiv2.SwaggerOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The consumes at the given index.
-
getConsumesBytes
public com.google.protobuf.ByteString getConsumesBytes(int index)
A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Specified by:
getConsumesBytesin interfaceOpenapiv2.SwaggerOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the consumes at the given index.
-
setConsumes
public Openapiv2.Swagger.Builder setConsumes(int index, java.lang.String value)
A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Parameters:
index- The index to set the value at.value- The consumes to set.- Returns:
- This builder for chaining.
-
addConsumes
public Openapiv2.Swagger.Builder addConsumes(java.lang.String value)
A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Parameters:
value- The consumes to add.- Returns:
- This builder for chaining.
-
addAllConsumes
public Openapiv2.Swagger.Builder addAllConsumes(java.lang.Iterable<java.lang.String> values)
A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Parameters:
values- The consumes to add.- Returns:
- This builder for chaining.
-
clearConsumes
public Openapiv2.Swagger.Builder clearConsumes()
A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Returns:
- This builder for chaining.
-
addConsumesBytes
public Openapiv2.Swagger.Builder addConsumesBytes(com.google.protobuf.ByteString value)
A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Parameters:
value- The bytes of the consumes to add.- Returns:
- This builder for chaining.
-
getProducesList
public com.google.protobuf.ProtocolStringList getProducesList()
A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string produces = 7;- Specified by:
getProducesListin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- A list containing the produces.
-
getProducesCount
public int getProducesCount()
A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string produces = 7;- Specified by:
getProducesCountin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The count of produces.
-
getProduces
public java.lang.String getProduces(int index)
A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string produces = 7;- Specified by:
getProducesin interfaceOpenapiv2.SwaggerOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The produces at the given index.
-
getProducesBytes
public com.google.protobuf.ByteString getProducesBytes(int index)
A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string produces = 7;- Specified by:
getProducesBytesin interfaceOpenapiv2.SwaggerOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the produces at the given index.
-
setProduces
public Openapiv2.Swagger.Builder setProduces(int index, java.lang.String value)
A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string produces = 7;- Parameters:
index- The index to set the value at.value- The produces to set.- Returns:
- This builder for chaining.
-
addProduces
public Openapiv2.Swagger.Builder addProduces(java.lang.String value)
A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string produces = 7;- Parameters:
value- The produces to add.- Returns:
- This builder for chaining.
-
addAllProduces
public Openapiv2.Swagger.Builder addAllProduces(java.lang.Iterable<java.lang.String> values)
A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string produces = 7;- Parameters:
values- The produces to add.- Returns:
- This builder for chaining.
-
clearProduces
public Openapiv2.Swagger.Builder clearProduces()
A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string produces = 7;- Returns:
- This builder for chaining.
-
addProducesBytes
public Openapiv2.Swagger.Builder addProducesBytes(com.google.protobuf.ByteString value)
A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.
repeated string produces = 7;- Parameters:
value- The bytes of the produces to add.- Returns:
- This builder for chaining.
-
getResponsesCount
public int getResponsesCount()
Description copied from interface:Openapiv2.SwaggerOrBuilderAn object to hold responses that can be used across operations. This property does not define global responses for all operations.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;- Specified by:
getResponsesCountin interfaceOpenapiv2.SwaggerOrBuilder
-
containsResponses
public boolean containsResponses(java.lang.String key)
An object to hold responses that can be used across operations. This property does not define global responses for all operations.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;- Specified by:
containsResponsesin interfaceOpenapiv2.SwaggerOrBuilder
-
getResponses
@Deprecated public java.util.Map<java.lang.String,Openapiv2.Response> getResponses()
Deprecated.UsegetResponsesMap()instead.- Specified by:
getResponsesin interfaceOpenapiv2.SwaggerOrBuilder
-
getResponsesMap
public java.util.Map<java.lang.String,Openapiv2.Response> getResponsesMap()
An object to hold responses that can be used across operations. This property does not define global responses for all operations.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;- Specified by:
getResponsesMapin interfaceOpenapiv2.SwaggerOrBuilder
-
getResponsesOrDefault
public Openapiv2.Response getResponsesOrDefault(java.lang.String key, Openapiv2.Response defaultValue)
An object to hold responses that can be used across operations. This property does not define global responses for all operations.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;- Specified by:
getResponsesOrDefaultin interfaceOpenapiv2.SwaggerOrBuilder
-
getResponsesOrThrow
public Openapiv2.Response getResponsesOrThrow(java.lang.String key)
An object to hold responses that can be used across operations. This property does not define global responses for all operations.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;- Specified by:
getResponsesOrThrowin interfaceOpenapiv2.SwaggerOrBuilder
-
clearResponses
public Openapiv2.Swagger.Builder clearResponses()
-
removeResponses
public Openapiv2.Swagger.Builder removeResponses(java.lang.String key)
An object to hold responses that can be used across operations. This property does not define global responses for all operations.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
-
getMutableResponses
@Deprecated public java.util.Map<java.lang.String,Openapiv2.Response> getMutableResponses()
Deprecated.Use alternate mutation accessors instead.
-
putResponses
public Openapiv2.Swagger.Builder putResponses(java.lang.String key, Openapiv2.Response value)
An object to hold responses that can be used across operations. This property does not define global responses for all operations.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
-
putAllResponses
public Openapiv2.Swagger.Builder putAllResponses(java.util.Map<java.lang.String,Openapiv2.Response> values)
An object to hold responses that can be used across operations. This property does not define global responses for all operations.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
-
hasSecurityDefinitions
public boolean hasSecurityDefinitions()
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;- Specified by:
hasSecurityDefinitionsin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- Whether the securityDefinitions field is set.
-
getSecurityDefinitions
public Openapiv2.SecurityDefinitions getSecurityDefinitions()
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;- Specified by:
getSecurityDefinitionsin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The securityDefinitions.
-
setSecurityDefinitions
public Openapiv2.Swagger.Builder setSecurityDefinitions(Openapiv2.SecurityDefinitions value)
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
-
setSecurityDefinitions
public Openapiv2.Swagger.Builder setSecurityDefinitions(Openapiv2.SecurityDefinitions.Builder builderForValue)
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
-
mergeSecurityDefinitions
public Openapiv2.Swagger.Builder mergeSecurityDefinitions(Openapiv2.SecurityDefinitions value)
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
-
clearSecurityDefinitions
public Openapiv2.Swagger.Builder clearSecurityDefinitions()
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
-
getSecurityDefinitionsBuilder
public Openapiv2.SecurityDefinitions.Builder getSecurityDefinitionsBuilder()
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
-
getSecurityDefinitionsOrBuilder
public Openapiv2.SecurityDefinitionsOrBuilder getSecurityDefinitionsOrBuilder()
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;- Specified by:
getSecurityDefinitionsOrBuilderin interfaceOpenapiv2.SwaggerOrBuilder
-
getSecurityList
public java.util.List<Openapiv2.SecurityRequirement> getSecurityList()
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;- Specified by:
getSecurityListin interfaceOpenapiv2.SwaggerOrBuilder
-
getSecurityCount
public int getSecurityCount()
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;- Specified by:
getSecurityCountin interfaceOpenapiv2.SwaggerOrBuilder
-
getSecurity
public Openapiv2.SecurityRequirement getSecurity(int index)
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;- Specified by:
getSecurityin interfaceOpenapiv2.SwaggerOrBuilder
-
setSecurity
public Openapiv2.Swagger.Builder setSecurity(int index, Openapiv2.SecurityRequirement value)
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
setSecurity
public Openapiv2.Swagger.Builder setSecurity(int index, Openapiv2.SecurityRequirement.Builder builderForValue)
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
addSecurity
public Openapiv2.Swagger.Builder addSecurity(Openapiv2.SecurityRequirement value)
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
addSecurity
public Openapiv2.Swagger.Builder addSecurity(int index, Openapiv2.SecurityRequirement value)
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
addSecurity
public Openapiv2.Swagger.Builder addSecurity(Openapiv2.SecurityRequirement.Builder builderForValue)
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
addSecurity
public Openapiv2.Swagger.Builder addSecurity(int index, Openapiv2.SecurityRequirement.Builder builderForValue)
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
addAllSecurity
public Openapiv2.Swagger.Builder addAllSecurity(java.lang.Iterable<? extends Openapiv2.SecurityRequirement> values)
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
clearSecurity
public Openapiv2.Swagger.Builder clearSecurity()
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
removeSecurity
public Openapiv2.Swagger.Builder removeSecurity(int index)
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
getSecurityBuilder
public Openapiv2.SecurityRequirement.Builder getSecurityBuilder(int index)
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
getSecurityOrBuilder
public Openapiv2.SecurityRequirementOrBuilder getSecurityOrBuilder(int index)
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;- Specified by:
getSecurityOrBuilderin interfaceOpenapiv2.SwaggerOrBuilder
-
getSecurityOrBuilderList
public java.util.List<? extends Openapiv2.SecurityRequirementOrBuilder> getSecurityOrBuilderList()
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;- Specified by:
getSecurityOrBuilderListin interfaceOpenapiv2.SwaggerOrBuilder
-
addSecurityBuilder
public Openapiv2.SecurityRequirement.Builder addSecurityBuilder()
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
addSecurityBuilder
public Openapiv2.SecurityRequirement.Builder addSecurityBuilder(int index)
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
getSecurityBuilderList
public java.util.List<Openapiv2.SecurityRequirement.Builder> getSecurityBuilderList()
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
-
getTagsList
public java.util.List<Openapiv2.Tag> 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 .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;- Specified by:
getTagsListin interfaceOpenapiv2.SwaggerOrBuilder
-
getTagsCount
public 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 .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;- Specified by:
getTagsCountin interfaceOpenapiv2.SwaggerOrBuilder
-
getTags
public Openapiv2.Tag 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 .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;- Specified by:
getTagsin interfaceOpenapiv2.SwaggerOrBuilder
-
setTags
public Openapiv2.Swagger.Builder setTags(int index, Openapiv2.Tag value)
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
setTags
public Openapiv2.Swagger.Builder setTags(int index, Openapiv2.Tag.Builder builderForValue)
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
addTags
public Openapiv2.Swagger.Builder addTags(Openapiv2.Tag value)
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
addTags
public Openapiv2.Swagger.Builder addTags(int index, Openapiv2.Tag value)
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
addTags
public Openapiv2.Swagger.Builder addTags(Openapiv2.Tag.Builder builderForValue)
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
addTags
public Openapiv2.Swagger.Builder addTags(int index, Openapiv2.Tag.Builder builderForValue)
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
addAllTags
public Openapiv2.Swagger.Builder addAllTags(java.lang.Iterable<? extends Openapiv2.Tag> values)
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
clearTags
public Openapiv2.Swagger.Builder clearTags()
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
removeTags
public Openapiv2.Swagger.Builder removeTags(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 .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
getTagsBuilder
public Openapiv2.Tag.Builder getTagsBuilder(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 .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
getTagsOrBuilder
public Openapiv2.TagOrBuilder getTagsOrBuilder(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 .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;- Specified by:
getTagsOrBuilderin interfaceOpenapiv2.SwaggerOrBuilder
-
getTagsOrBuilderList
public java.util.List<? extends Openapiv2.TagOrBuilder> getTagsOrBuilderList()
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;- Specified by:
getTagsOrBuilderListin interfaceOpenapiv2.SwaggerOrBuilder
-
addTagsBuilder
public Openapiv2.Tag.Builder addTagsBuilder()
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
addTagsBuilder
public Openapiv2.Tag.Builder addTagsBuilder(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 .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
getTagsBuilderList
public java.util.List<Openapiv2.Tag.Builder> getTagsBuilderList()
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
-
hasExternalDocs
public boolean hasExternalDocs()
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;- Specified by:
hasExternalDocsin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- Whether the externalDocs field is set.
-
getExternalDocs
public Openapiv2.ExternalDocumentation getExternalDocs()
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;- Specified by:
getExternalDocsin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The externalDocs.
-
setExternalDocs
public Openapiv2.Swagger.Builder setExternalDocs(Openapiv2.ExternalDocumentation value)
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
-
setExternalDocs
public Openapiv2.Swagger.Builder setExternalDocs(Openapiv2.ExternalDocumentation.Builder builderForValue)
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
-
mergeExternalDocs
public Openapiv2.Swagger.Builder mergeExternalDocs(Openapiv2.ExternalDocumentation value)
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
-
clearExternalDocs
public Openapiv2.Swagger.Builder clearExternalDocs()
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
-
getExternalDocsBuilder
public Openapiv2.ExternalDocumentation.Builder getExternalDocsBuilder()
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
-
getExternalDocsOrBuilder
public Openapiv2.ExternalDocumentationOrBuilder getExternalDocsOrBuilder()
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;- Specified by:
getExternalDocsOrBuilderin interfaceOpenapiv2.SwaggerOrBuilder
-
getExtensionsCount
public int getExtensionsCount()
Description copied from interface:Openapiv2.SwaggerOrBuilderCustom 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 = 15;- Specified by:
getExtensionsCountin interfaceOpenapiv2.SwaggerOrBuilder
-
containsExtensions
public 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 = 15;- Specified by:
containsExtensionsin interfaceOpenapiv2.SwaggerOrBuilder
-
getExtensions
@Deprecated public java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensions()
Deprecated.UsegetExtensionsMap()instead.- Specified by:
getExtensionsin interfaceOpenapiv2.SwaggerOrBuilder
-
getExtensionsMap
public 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 = 15;- Specified by:
getExtensionsMapin interfaceOpenapiv2.SwaggerOrBuilder
-
getExtensionsOrDefault
public 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 = 15;- Specified by:
getExtensionsOrDefaultin interfaceOpenapiv2.SwaggerOrBuilder
-
getExtensionsOrThrow
public 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 = 15;- Specified by:
getExtensionsOrThrowin interfaceOpenapiv2.SwaggerOrBuilder
-
clearExtensions
public Openapiv2.Swagger.Builder clearExtensions()
-
removeExtensions
public Openapiv2.Swagger.Builder removeExtensions(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 = 15;
-
getMutableExtensions
@Deprecated public java.util.Map<java.lang.String,com.google.protobuf.Value> getMutableExtensions()
Deprecated.Use alternate mutation accessors instead.
-
putExtensions
public Openapiv2.Swagger.Builder putExtensions(java.lang.String key, com.google.protobuf.Value value)
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 = 15;
-
putAllExtensions
public Openapiv2.Swagger.Builder putAllExtensions(java.util.Map<java.lang.String,com.google.protobuf.Value> values)
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 = 15;
-
setUnknownFields
public final Openapiv2.Swagger.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
mergeUnknownFields
public final Openapiv2.Swagger.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
-
-