public static final class Info.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder> implements InfoOrBuilder
`Info` is a representation of OpenAPI v2 specification's Info object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#infoObject
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";
};
};
...
};
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Info| Modifier and Type | Method and Description |
|---|---|
Info.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Info |
build() |
Info |
buildPartial() |
Info.Builder |
clear() |
Info.Builder |
clearContact()
The contact information for the exposed API.
|
Info.Builder |
clearDescription()
A short description of the application.
|
Info.Builder |
clearExtensions() |
Info.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Info.Builder |
clearLicense()
The license information for the exposed API.
|
Info.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Info.Builder |
clearTermsOfService()
The Terms of Service for the API.
|
Info.Builder |
clearTitle()
The title of the application.
|
Info.Builder |
clearVersion()
Provides the version of the application API (not to be confused
with the specification version).
|
Info.Builder |
clone() |
boolean |
containsExtensions(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.
|
Contact |
getContact()
The contact information for the exposed API.
|
Contact.Builder |
getContactBuilder()
The contact information for the exposed API.
|
ContactOrBuilder |
getContactOrBuilder()
The contact information for the exposed API.
|
Info |
getDefaultInstanceForType() |
String |
getDescription()
A short description of the application.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
A short description of the application.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Map<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.
|
Map<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(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(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.
|
License |
getLicense()
The license information for the exposed API.
|
License.Builder |
getLicenseBuilder()
The license information for the exposed API.
|
LicenseOrBuilder |
getLicenseOrBuilder()
The license information for the exposed API.
|
Map<String,com.google.protobuf.Value> |
getMutableExtensions()
Deprecated.
|
String |
getTermsOfService()
The Terms of Service for the API.
|
com.google.protobuf.ByteString |
getTermsOfServiceBytes()
The Terms of Service for the API.
|
String |
getTitle()
The title of the application.
|
com.google.protobuf.ByteString |
getTitleBytes()
The title of the application.
|
String |
getVersion()
Provides the version of the application API (not to be confused
with the specification version).
|
com.google.protobuf.ByteString |
getVersionBytes()
Provides the version of the application API (not to be confused
with the specification version).
|
boolean |
hasContact()
The contact information for the exposed API.
|
boolean |
hasLicense()
The license information for the exposed API.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number) |
Info.Builder |
mergeContact(Contact value)
The contact information for the exposed API.
|
Info.Builder |
mergeLicense(License value)
The license information for the exposed API.
|
Info.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Info.Builder |
putAllExtensions(Map<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.
|
Info.Builder |
putExtensions(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.
|
com.google.protobuf.Value.Builder |
putExtensionsBuilderIfAbsent(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.
|
Info.Builder |
removeExtensions(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.
|
Info.Builder |
setContact(Contact.Builder builderForValue)
The contact information for the exposed API.
|
Info.Builder |
setContact(Contact value)
The contact information for the exposed API.
|
Info.Builder |
setDescription(String value)
A short description of the application.
|
Info.Builder |
setDescriptionBytes(com.google.protobuf.ByteString value)
A short description of the application.
|
Info.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Info.Builder |
setLicense(License.Builder builderForValue)
The license information for the exposed API.
|
Info.Builder |
setLicense(License value)
The license information for the exposed API.
|
Info.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Info.Builder |
setTermsOfService(String value)
The Terms of Service for the API.
|
Info.Builder |
setTermsOfServiceBytes(com.google.protobuf.ByteString value)
The Terms of Service for the API.
|
Info.Builder |
setTitle(String value)
The title of the application.
|
Info.Builder |
setTitleBytes(com.google.protobuf.ByteString value)
The title of the application.
|
Info.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Info.Builder |
setVersion(String value)
Provides the version of the application API (not to be confused
with the specification version).
|
Info.Builder |
setVersionBytes(com.google.protobuf.ByteString value)
Provides the version of the application API (not to be confused
with the specification version).
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, isInitialized, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>public Info.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>public Info getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Info build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Info buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Info.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>public Info.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>public Info.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>public Info.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>public Info.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>public Info.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>public String getTitle()
The title of the application.
string title = 1 [json_name = "title"];getTitle in interface InfoOrBuilderpublic com.google.protobuf.ByteString getTitleBytes()
The title of the application.
string title = 1 [json_name = "title"];getTitleBytes in interface InfoOrBuilderpublic Info.Builder setTitle(String value)
The title of the application.
string title = 1 [json_name = "title"];value - The title to set.public Info.Builder clearTitle()
The title of the application.
string title = 1 [json_name = "title"];public Info.Builder setTitleBytes(com.google.protobuf.ByteString value)
The title of the application.
string title = 1 [json_name = "title"];value - The bytes for title to set.public String getDescription()
A short description of the application. GFM syntax can be used for rich text representation.
string description = 2 [json_name = "description"];getDescription in interface InfoOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
A short description of the application. GFM syntax can be used for rich text representation.
string description = 2 [json_name = "description"];getDescriptionBytes in interface InfoOrBuilderpublic Info.Builder setDescription(String value)
A short description of the application. GFM syntax can be used for rich text representation.
string description = 2 [json_name = "description"];value - The description to set.public Info.Builder clearDescription()
A short description of the application. GFM syntax can be used for rich text representation.
string description = 2 [json_name = "description"];public Info.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
A short description of the application. GFM syntax can be used for rich text representation.
string description = 2 [json_name = "description"];value - The bytes for description to set.public String getTermsOfService()
The Terms of Service for the API.
string terms_of_service = 3 [json_name = "termsOfService"];getTermsOfService in interface InfoOrBuilderpublic com.google.protobuf.ByteString getTermsOfServiceBytes()
The Terms of Service for the API.
string terms_of_service = 3 [json_name = "termsOfService"];getTermsOfServiceBytes in interface InfoOrBuilderpublic Info.Builder setTermsOfService(String value)
The Terms of Service for the API.
string terms_of_service = 3 [json_name = "termsOfService"];value - The termsOfService to set.public Info.Builder clearTermsOfService()
The Terms of Service for the API.
string terms_of_service = 3 [json_name = "termsOfService"];public Info.Builder setTermsOfServiceBytes(com.google.protobuf.ByteString value)
The Terms of Service for the API.
string terms_of_service = 3 [json_name = "termsOfService"];value - The bytes for termsOfService to set.public boolean hasContact()
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];hasContact in interface InfoOrBuilderpublic Contact getContact()
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];getContact in interface InfoOrBuilderpublic Info.Builder setContact(Contact value)
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];public Info.Builder setContact(Contact.Builder builderForValue)
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];public Info.Builder mergeContact(Contact value)
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];public Info.Builder clearContact()
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];public Contact.Builder getContactBuilder()
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];public ContactOrBuilder getContactOrBuilder()
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];getContactOrBuilder in interface InfoOrBuilderpublic boolean hasLicense()
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];hasLicense in interface InfoOrBuilderpublic License getLicense()
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];getLicense in interface InfoOrBuilderpublic Info.Builder setLicense(License value)
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];public Info.Builder setLicense(License.Builder builderForValue)
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];public Info.Builder mergeLicense(License value)
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];public Info.Builder clearLicense()
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];public License.Builder getLicenseBuilder()
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];public LicenseOrBuilder getLicenseOrBuilder()
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];getLicenseOrBuilder in interface InfoOrBuilderpublic String getVersion()
Provides the version of the application API (not to be confused with the specification version).
string version = 6 [json_name = "version"];getVersion in interface InfoOrBuilderpublic com.google.protobuf.ByteString getVersionBytes()
Provides the version of the application API (not to be confused with the specification version).
string version = 6 [json_name = "version"];getVersionBytes in interface InfoOrBuilderpublic Info.Builder setVersion(String value)
Provides the version of the application API (not to be confused with the specification version).
string version = 6 [json_name = "version"];value - The version to set.public Info.Builder clearVersion()
Provides the version of the application API (not to be confused with the specification version).
string version = 6 [json_name = "version"];public Info.Builder setVersionBytes(com.google.protobuf.ByteString value)
Provides the version of the application API (not to be confused with the specification version).
string version = 6 [json_name = "version"];value - The bytes for version to set.public int getExtensionsCount()
InfoOrBuilderCustom 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 = 7 [json_name = "extensions"];getExtensionsCount in interface InfoOrBuilderpublic boolean containsExtensions(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 = 7 [json_name = "extensions"];containsExtensions in interface InfoOrBuilder@Deprecated public Map<String,com.google.protobuf.Value> getExtensions()
getExtensionsMap() instead.getExtensions in interface InfoOrBuilderpublic Map<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 = 7 [json_name = "extensions"];getExtensionsMap in interface InfoOrBuilderpublic com.google.protobuf.Value getExtensionsOrDefault(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 = 7 [json_name = "extensions"];getExtensionsOrDefault in interface InfoOrBuilderpublic com.google.protobuf.Value getExtensionsOrThrow(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 = 7 [json_name = "extensions"];getExtensionsOrThrow in interface InfoOrBuilderpublic Info.Builder clearExtensions()
public Info.Builder removeExtensions(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 = 7 [json_name = "extensions"];@Deprecated public Map<String,com.google.protobuf.Value> getMutableExtensions()
public Info.Builder putExtensions(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 = 7 [json_name = "extensions"];public Info.Builder putAllExtensions(Map<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 = 7 [json_name = "extensions"];public com.google.protobuf.Value.Builder putExtensionsBuilderIfAbsent(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 = 7 [json_name = "extensions"];public final Info.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>public final Info.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Info.Builder>Copyright © 2023. All rights reserved.