com.grpc.gateway.protoc_gen_openapiv2.options

Class Info.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<Info.Builder>

com.grpc.gateway.protoc_gen_openapiv2.options.Info.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, InfoOrBuilder, java.lang.Cloneable

Enclosing class:

Info

public static final class Info.Builder
extends com.google.protobuf.GeneratedMessage.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

Method Summary

Modifier and Type	Method and Description
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	clearLicense() The license information for the exposed API.
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).
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.
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()
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() Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
java.util.Map<java.lang.String,com.google.protobuf.Value>	getExtensionsMap() Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
com.google.protobuf.Value	getExtensionsOrDefault(java.lang.String key, com.google.protobuf.Value defaultValue) Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
com.google.protobuf.Value	getExtensionsOrThrow(java.lang.String key) Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
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.
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.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMutableMapFieldReflection(int number)
boolean	isInitialized()
Info.Builder	mergeContact(Contact value) The contact information for the exposed API.
Info.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Info.Builder	mergeFrom(Info other)
Info.Builder	mergeFrom(com.google.protobuf.Message other)
Info.Builder	mergeLicense(License value) The license information for the exposed API.
Info.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.
Info.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.
com.google.protobuf.Value.Builder	putExtensionsBuilderIfAbsent(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.
Info.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.
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(java.lang.String value) A short description of the application.
Info.Builder	setDescriptionBytes(com.google.protobuf.ByteString value) A short description of the application.
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	setTermsOfService(java.lang.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(java.lang.String value) The title of the application.
Info.Builder	setTitleBytes(com.google.protobuf.ByteString value) The title of the application.
Info.Builder	setVersion(java.lang.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).

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Info.Builder>

internalGetMutableMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Overrides:

internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Info.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Info.Builder>

clear

public Info.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Info.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Info.Builder>

getDefaultInstanceForType

public Info getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Info build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Info buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public Info.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Info.Builder>

mergeFrom

public Info.Builder mergeFrom(Info other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Info.Builder>

mergeFrom

public Info.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Info.Builder>

Throws:

java.io.IOException

getTitle

public java.lang.String getTitle()

 The title of the application.
 

string title = 1 [json_name = "title"];

Specified by:

getTitle in interface InfoOrBuilder

Returns:

The title.

getTitleBytes

public com.google.protobuf.ByteString getTitleBytes()

 The title of the application.
 

string title = 1 [json_name = "title"];

Specified by:

getTitleBytes in interface InfoOrBuilder

Returns:

The bytes for title.

setTitle

public Info.Builder setTitle(java.lang.String value)

 The title of the application.
 

string title = 1 [json_name = "title"];

Parameters:

value - The title to set.

Returns:

This builder for chaining.

clearTitle

public Info.Builder clearTitle()

 The title of the application.
 

string title = 1 [json_name = "title"];

Returns:

This builder for chaining.

setTitleBytes

public Info.Builder setTitleBytes(com.google.protobuf.ByteString value)

 The title of the application.
 

string title = 1 [json_name = "title"];

Parameters:

value - The bytes for title to set.

Returns:

This builder for chaining.

getDescription

public java.lang.String getDescription()

 A short description of the application. GFM syntax can be used for rich
 text representation.
 

string description = 2 [json_name = "description"];

Specified by:

getDescription in interface InfoOrBuilder

Returns:

The description.

getDescriptionBytes

public 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"];

Specified by:

getDescriptionBytes in interface InfoOrBuilder

Returns:

The bytes for description.

setDescription

public 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 [json_name = "description"];

Parameters:

value - The description to set.

Returns:

This builder for chaining.

clearDescription

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"];

Returns:

This builder for chaining.

setDescriptionBytes

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"];

Parameters:

value - The bytes for description to set.

Returns:

This builder for chaining.

getTermsOfService

public java.lang.String getTermsOfService()

 The Terms of Service for the API.
 

string terms_of_service = 3 [json_name = "termsOfService"];

Specified by:

getTermsOfService in interface InfoOrBuilder

Returns:

The termsOfService.

getTermsOfServiceBytes

public com.google.protobuf.ByteString getTermsOfServiceBytes()

 The Terms of Service for the API.
 

string terms_of_service = 3 [json_name = "termsOfService"];

Specified by:

getTermsOfServiceBytes in interface InfoOrBuilder

Returns:

The bytes for termsOfService.

setTermsOfService

public Info.Builder setTermsOfService(java.lang.String value)

 The Terms of Service for the API.
 

string terms_of_service = 3 [json_name = "termsOfService"];

Parameters:

value - The termsOfService to set.

Returns:

This builder for chaining.

clearTermsOfService

public Info.Builder clearTermsOfService()

 The Terms of Service for the API.
 

string terms_of_service = 3 [json_name = "termsOfService"];

Returns:

This builder for chaining.

setTermsOfServiceBytes

public Info.Builder setTermsOfServiceBytes(com.google.protobuf.ByteString value)

 The Terms of Service for the API.
 

string terms_of_service = 3 [json_name = "termsOfService"];

Parameters:

value - The bytes for termsOfService to set.

Returns:

This builder for chaining.

hasContact

public boolean hasContact()

 The contact information for the exposed API.
 

.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];

Specified by:

hasContact in interface InfoOrBuilder

Returns:

Whether the contact field is set.

getContact

public Contact getContact()

 The contact information for the exposed API.
 

.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];

Specified by:

getContact in interface InfoOrBuilder

Returns:

The contact.

setContact

public Info.Builder setContact(Contact value)

 The contact information for the exposed API.
 

.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];

setContact

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"];

mergeContact

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"];

clearContact

public Info.Builder clearContact()

 The contact information for the exposed API.
 

.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];

getContactBuilder

public Contact.Builder getContactBuilder()

 The contact information for the exposed API.
 

.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];

getContactOrBuilder

public ContactOrBuilder getContactOrBuilder()

 The contact information for the exposed API.
 

.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4 [json_name = "contact"];

Specified by:

getContactOrBuilder in interface InfoOrBuilder

hasLicense

public boolean hasLicense()

 The license information for the exposed API.
 

.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];

Specified by:

hasLicense in interface InfoOrBuilder

Returns:

Whether the license field is set.

getLicense

public License getLicense()

 The license information for the exposed API.
 

.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];

Specified by:

getLicense in interface InfoOrBuilder

Returns:

The license.

setLicense

public Info.Builder setLicense(License value)

 The license information for the exposed API.
 

.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];

setLicense

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"];

mergeLicense

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"];

clearLicense

public Info.Builder clearLicense()

 The license information for the exposed API.
 

.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];

getLicenseBuilder

public License.Builder getLicenseBuilder()

 The license information for the exposed API.
 

.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];

getLicenseOrBuilder

public LicenseOrBuilder getLicenseOrBuilder()

 The license information for the exposed API.
 

.grpc.gateway.protoc_gen_openapiv2.options.License license = 5 [json_name = "license"];

Specified by:

getLicenseOrBuilder in interface InfoOrBuilder

getVersion

public java.lang.String getVersion()

 Provides the version of the application API (not to be confused
 with the specification version).
 

string version = 6 [json_name = "version"];

Specified by:

getVersion in interface InfoOrBuilder

Returns:

The version.

getVersionBytes

public 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"];

Specified by:

getVersionBytes in interface InfoOrBuilder

Returns:

The bytes for version.

setVersion

public 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 [json_name = "version"];

Parameters:

value - The version to set.

Returns:

This builder for chaining.

clearVersion

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"];

Returns:

This builder for chaining.

setVersionBytes

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"];

Parameters:

value - The bytes for version to set.

Returns:

This builder for chaining.

getExtensionsCount

public int getExtensionsCount()

Description copied from interface: InfoOrBuilder

 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"];

Specified by:

getExtensionsCount in interface InfoOrBuilder

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 = 7 [json_name = "extensions"];

Specified by:

containsExtensions in interface InfoOrBuilder

getExtensions

@Deprecated
public java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensions()

Deprecated.

Use getExtensionsMap() instead.

Specified by:

getExtensions in interface InfoOrBuilder

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 = 7 [json_name = "extensions"];

Specified by:

getExtensionsMap in interface InfoOrBuilder

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 = 7 [json_name = "extensions"];

Specified by:

getExtensionsOrDefault in interface InfoOrBuilder

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 = 7 [json_name = "extensions"];

Specified by:

getExtensionsOrThrow in interface InfoOrBuilder

clearExtensions

public Info.Builder clearExtensions()

removeExtensions

public Info.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 = 7 [json_name = "extensions"];

getMutableExtensions

@Deprecated
public java.util.Map<java.lang.String,com.google.protobuf.Value> getMutableExtensions()

Deprecated.

Use alternate mutation accessors instead.

putExtensions

public Info.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 = 7 [json_name = "extensions"];

putAllExtensions

public Info.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 = 7 [json_name = "extensions"];

putExtensionsBuilderIfAbsent

public com.google.protobuf.Value.Builder putExtensionsBuilderIfAbsent(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 = 7 [json_name = "extensions"];