public static final class Openapiv2.Info.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Info.Builder> implements Openapiv2.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/master/LICENSE.txt";
};
};
...
};
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Info| Modifier and Type | Method and Description |
|---|---|
Openapiv2.Info.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) |
Openapiv2.Info |
build() |
Openapiv2.Info |
buildPartial() |
Openapiv2.Info.Builder |
clear() |
Openapiv2.Info.Builder |
clearContact()
The contact information for the exposed API.
|
Openapiv2.Info.Builder |
clearDescription()
A short description of the application.
|
Openapiv2.Info.Builder |
clearExtensions() |
Openapiv2.Info.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Openapiv2.Info.Builder |
clearLicense()
The license information for the exposed API.
|
Openapiv2.Info.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Openapiv2.Info.Builder |
clearTermsOfService()
The Terms of Service for the API.
|
Openapiv2.Info.Builder |
clearTitle()
The title of the application.
|
Openapiv2.Info.Builder |
clearVersion()
Provides the version of the application API (not to be confused
with the specification version).
|
Openapiv2.Info.Builder |
clone() |
boolean |
containsExtensions(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 7; |
Openapiv2.Contact |
getContact()
The contact information for the exposed API.
|
Openapiv2.Contact.Builder |
getContactBuilder()
The contact information for the exposed API.
|
Openapiv2.ContactOrBuilder |
getContactOrBuilder()
The contact information for the exposed API.
|
Openapiv2.Info |
getDefaultInstanceForType() |
java.lang.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() |
java.util.Map<java.lang.String,com.google.protobuf.Value> |
getExtensions()
Deprecated.
|
int |
getExtensionsCount()
map<string, .google.protobuf.Value> extensions = 7; |
java.util.Map<java.lang.String,com.google.protobuf.Value> |
getExtensionsMap()
map<string, .google.protobuf.Value> extensions = 7; |
com.google.protobuf.Value |
getExtensionsOrDefault(java.lang.String key,
com.google.protobuf.Value defaultValue)
map<string, .google.protobuf.Value> extensions = 7; |
com.google.protobuf.Value |
getExtensionsOrThrow(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 7; |
Openapiv2.License |
getLicense()
The license information for the exposed API.
|
Openapiv2.License.Builder |
getLicenseBuilder()
The license information for the exposed API.
|
Openapiv2.LicenseOrBuilder |
getLicenseOrBuilder()
The license information for the exposed API.
|
java.util.Map<java.lang.String,com.google.protobuf.Value> |
getMutableExtensions()
Deprecated.
|
java.lang.String |
getTermsOfService()
The Terms of Service for the API.
|
com.google.protobuf.ByteString |
getTermsOfServiceBytes()
The Terms of Service for the API.
|
java.lang.String |
getTitle()
The title of the application.
|
com.google.protobuf.ByteString |
getTitleBytes()
The title of the application.
|
java.lang.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.MapField |
internalGetMapField(int number) |
protected com.google.protobuf.MapField |
internalGetMutableMapField(int number) |
boolean |
isInitialized() |
Openapiv2.Info.Builder |
mergeContact(Openapiv2.Contact value)
The contact information for the exposed API.
|
Openapiv2.Info.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Openapiv2.Info.Builder |
mergeFrom(com.google.protobuf.Message other) |
Openapiv2.Info.Builder |
mergeFrom(Openapiv2.Info other) |
Openapiv2.Info.Builder |
mergeLicense(Openapiv2.License value)
The license information for the exposed API.
|
Openapiv2.Info.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Openapiv2.Info.Builder |
putAllExtensions(java.util.Map<java.lang.String,com.google.protobuf.Value> values)
map<string, .google.protobuf.Value> extensions = 7; |
Openapiv2.Info.Builder |
putExtensions(java.lang.String key,
com.google.protobuf.Value value)
map<string, .google.protobuf.Value> extensions = 7; |
Openapiv2.Info.Builder |
removeExtensions(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 7; |
Openapiv2.Info.Builder |
setContact(Openapiv2.Contact.Builder builderForValue)
The contact information for the exposed API.
|
Openapiv2.Info.Builder |
setContact(Openapiv2.Contact value)
The contact information for the exposed API.
|
Openapiv2.Info.Builder |
setDescription(java.lang.String value)
A short description of the application.
|
Openapiv2.Info.Builder |
setDescriptionBytes(com.google.protobuf.ByteString value)
A short description of the application.
|
Openapiv2.Info.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) |
Openapiv2.Info.Builder |
setLicense(Openapiv2.License.Builder builderForValue)
The license information for the exposed API.
|
Openapiv2.Info.Builder |
setLicense(Openapiv2.License value)
The license information for the exposed API.
|
Openapiv2.Info.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
Openapiv2.Info.Builder |
setTermsOfService(java.lang.String value)
The Terms of Service for the API.
|
Openapiv2.Info.Builder |
setTermsOfServiceBytes(com.google.protobuf.ByteString value)
The Terms of Service for the API.
|
Openapiv2.Info.Builder |
setTitle(java.lang.String value)
The title of the application.
|
Openapiv2.Info.Builder |
setTitleBytes(com.google.protobuf.ByteString value)
The title of the application.
|
Openapiv2.Info.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Openapiv2.Info.Builder |
setVersion(java.lang.String value)
Provides the version of the application API (not to be confused
with the specification version).
|
Openapiv2.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, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Info.Builder>protected com.google.protobuf.MapField internalGetMutableMapField(int number)
internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Info.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Info.Builder>public Openapiv2.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<Openapiv2.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<Openapiv2.Info.Builder>public Openapiv2.Info getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Openapiv2.Info build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Openapiv2.Info buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Openapiv2.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<Openapiv2.Info.Builder>public Openapiv2.Info.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Info.Builder>public Openapiv2.Info.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Info.Builder>public Openapiv2.Info.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Info.Builder>public Openapiv2.Info.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Info.Builder>public Openapiv2.Info.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Info.Builder>public Openapiv2.Info.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openapiv2.Info.Builder>public Openapiv2.Info.Builder mergeFrom(Openapiv2.Info other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Info.Builder>public Openapiv2.Info.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openapiv2.Info.Builder>java.io.IOExceptionpublic java.lang.String getTitle()
The title of the application.
string title = 1;getTitle in interface Openapiv2.InfoOrBuilderpublic com.google.protobuf.ByteString getTitleBytes()
The title of the application.
string title = 1;getTitleBytes in interface Openapiv2.InfoOrBuilderpublic Openapiv2.Info.Builder setTitle(java.lang.String value)
The title of the application.
string title = 1;value - The title to set.public Openapiv2.Info.Builder clearTitle()
The title of the application.
string title = 1;public Openapiv2.Info.Builder setTitleBytes(com.google.protobuf.ByteString value)
The title of the application.
string title = 1;value - The bytes for title to set.public java.lang.String getDescription()
A short description of the application. GFM syntax can be used for rich text representation.
string description = 2;getDescription in interface Openapiv2.InfoOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
A short description of the application. GFM syntax can be used for rich text representation.
string description = 2;getDescriptionBytes in interface Openapiv2.InfoOrBuilderpublic Openapiv2.Info.Builder setDescription(java.lang.String value)
A short description of the application. GFM syntax can be used for rich text representation.
string description = 2;value - The description to set.public Openapiv2.Info.Builder clearDescription()
A short description of the application. GFM syntax can be used for rich text representation.
string description = 2;public Openapiv2.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;value - The bytes for description to set.public java.lang.String getTermsOfService()
The Terms of Service for the API.
string terms_of_service = 3;getTermsOfService in interface Openapiv2.InfoOrBuilderpublic com.google.protobuf.ByteString getTermsOfServiceBytes()
The Terms of Service for the API.
string terms_of_service = 3;getTermsOfServiceBytes in interface Openapiv2.InfoOrBuilderpublic Openapiv2.Info.Builder setTermsOfService(java.lang.String value)
The Terms of Service for the API.
string terms_of_service = 3;value - The termsOfService to set.public Openapiv2.Info.Builder clearTermsOfService()
The Terms of Service for the API.
string terms_of_service = 3;public Openapiv2.Info.Builder setTermsOfServiceBytes(com.google.protobuf.ByteString value)
The Terms of Service for the API.
string terms_of_service = 3;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;hasContact in interface Openapiv2.InfoOrBuilderpublic Openapiv2.Contact getContact()
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;getContact in interface Openapiv2.InfoOrBuilderpublic Openapiv2.Info.Builder setContact(Openapiv2.Contact value)
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;public Openapiv2.Info.Builder setContact(Openapiv2.Contact.Builder builderForValue)
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;public Openapiv2.Info.Builder mergeContact(Openapiv2.Contact value)
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;public Openapiv2.Info.Builder clearContact()
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;public Openapiv2.Contact.Builder getContactBuilder()
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;public Openapiv2.ContactOrBuilder getContactOrBuilder()
The contact information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;getContactOrBuilder in interface Openapiv2.InfoOrBuilderpublic boolean hasLicense()
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5;hasLicense in interface Openapiv2.InfoOrBuilderpublic Openapiv2.License getLicense()
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5;getLicense in interface Openapiv2.InfoOrBuilderpublic Openapiv2.Info.Builder setLicense(Openapiv2.License value)
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5;public Openapiv2.Info.Builder setLicense(Openapiv2.License.Builder builderForValue)
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5;public Openapiv2.Info.Builder mergeLicense(Openapiv2.License value)
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5;public Openapiv2.Info.Builder clearLicense()
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5;public Openapiv2.License.Builder getLicenseBuilder()
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5;public Openapiv2.LicenseOrBuilder getLicenseOrBuilder()
The license information for the exposed API.
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5;getLicenseOrBuilder in interface Openapiv2.InfoOrBuilderpublic java.lang.String getVersion()
Provides the version of the application API (not to be confused with the specification version).
string version = 6;getVersion in interface Openapiv2.InfoOrBuilderpublic com.google.protobuf.ByteString getVersionBytes()
Provides the version of the application API (not to be confused with the specification version).
string version = 6;getVersionBytes in interface Openapiv2.InfoOrBuilderpublic Openapiv2.Info.Builder setVersion(java.lang.String value)
Provides the version of the application API (not to be confused with the specification version).
string version = 6;value - The version to set.public Openapiv2.Info.Builder clearVersion()
Provides the version of the application API (not to be confused with the specification version).
string version = 6;public Openapiv2.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;value - The bytes for version to set.public int getExtensionsCount()
Openapiv2.InfoOrBuildermap<string, .google.protobuf.Value> extensions = 7;getExtensionsCount in interface Openapiv2.InfoOrBuilderpublic boolean containsExtensions(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 7;containsExtensions in interface Openapiv2.InfoOrBuilder@Deprecated public java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensions()
getExtensionsMap() instead.getExtensions in interface Openapiv2.InfoOrBuilderpublic java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensionsMap()
map<string, .google.protobuf.Value> extensions = 7;getExtensionsMap in interface Openapiv2.InfoOrBuilderpublic com.google.protobuf.Value getExtensionsOrDefault(java.lang.String key,
com.google.protobuf.Value defaultValue)
map<string, .google.protobuf.Value> extensions = 7;getExtensionsOrDefault in interface Openapiv2.InfoOrBuilderpublic com.google.protobuf.Value getExtensionsOrThrow(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 7;getExtensionsOrThrow in interface Openapiv2.InfoOrBuilderpublic Openapiv2.Info.Builder clearExtensions()
public Openapiv2.Info.Builder removeExtensions(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 7;@Deprecated public java.util.Map<java.lang.String,com.google.protobuf.Value> getMutableExtensions()
public Openapiv2.Info.Builder putExtensions(java.lang.String key, com.google.protobuf.Value value)
map<string, .google.protobuf.Value> extensions = 7;public Openapiv2.Info.Builder putAllExtensions(java.util.Map<java.lang.String,com.google.protobuf.Value> values)
map<string, .google.protobuf.Value> extensions = 7;public final Openapiv2.Info.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Info.Builder>public final Openapiv2.Info.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Info.Builder>