java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessage
    - - grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Info

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.InfoOrBuilder, java.io.Serializable

Enclosing class:: Openapiv2

public static final class Openapiv2.Info
extends com.google.protobuf.GeneratedMessage
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/main/LICENSE";
 };
 };
 ...
 };

Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Info

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Openapiv2.Info.Builder
`Info` is a representation of OpenAPI v2 specification's Info object.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
  com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
  com.google.protobuf.AbstractMessage.BuilderParent
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`CONTACT_FIELD_NUMBER`
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`EXTENSIONS_FIELD_NUMBER`
`static int`	`LICENSE_FIELD_NUMBER`
`static int`	`TERMS_OF_SERVICE_FIELD_NUMBER`
`static int`	`TITLE_FIELD_NUMBER`
`static int`	`VERSION_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`containsExtensions(java.lang.String key)`	Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
`boolean`	`equals(java.lang.Object obj)`
`Openapiv2.Contact`	`getContact()`	The contact information for the exposed API.
`Openapiv2.ContactOrBuilder`	`getContactOrBuilder()`	The contact information for the exposed API.
`static Openapiv2.Info`	`getDefaultInstance()`
`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()`
`java.util.Map<java.lang.String,com.google.protobuf.Value>`	`getExtensions()`	Deprecated.
`int`	`getExtensionsCount()`	Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
`java.util.Map<java.lang.String,com.google.protobuf.Value>`	`getExtensionsMap()`	Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
`com.google.protobuf.Value`	`getExtensionsOrDefault(java.lang.String key, com.google.protobuf.Value defaultValue)`	Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
`com.google.protobuf.Value`	`getExtensionsOrThrow(java.lang.String key)`	Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
`Openapiv2.License`	`getLicense()`	The license information for the exposed API.
`Openapiv2.LicenseOrBuilder`	`getLicenseOrBuilder()`	The license information for the exposed API.
`com.google.protobuf.Parser<Openapiv2.Info>`	`getParserForType()`
`int`	`getSerializedSize()`
`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.
`int`	`hashCode()`
`boolean`	`hasLicense()`	The license information for the exposed API.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static Openapiv2.Info.Builder`	`newBuilder()`
`static Openapiv2.Info.Builder`	`newBuilder(Openapiv2.Info prototype)`
`Openapiv2.Info.Builder`	`newBuilderForType()`
`protected Openapiv2.Info.Builder`	`newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)`
`static Openapiv2.Info`	`parseDelimitedFrom(java.io.InputStream input)`
`static Openapiv2.Info`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openapiv2.Info`	`parseFrom(byte[] data)`
`static Openapiv2.Info`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openapiv2.Info`	`parseFrom(com.google.protobuf.ByteString data)`
`static Openapiv2.Info`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openapiv2.Info`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Openapiv2.Info`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openapiv2.Info`	`parseFrom(java.io.InputStream input)`
`static Openapiv2.Info`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openapiv2.Info`	`parseFrom(java.nio.ByteBuffer data)`
`static Openapiv2.Info`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Openapiv2.Info>`	`parser()`
`Openapiv2.Info.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail
- TITLE_FIELD_NUMBER
```
public static final int TITLE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TERMS_OF_SERVICE_FIELD_NUMBER
```
public static final int TERMS_OF_SERVICE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONTACT_FIELD_NUMBER
```
public static final int CONTACT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LICENSE_FIELD_NUMBER
```
public static final int LICENSE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- VERSION_FIELD_NUMBER
```
public static final int VERSION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXTENSIONS_FIELD_NUMBER
```
public static final int EXTENSIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

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

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getTitle
```
public java.lang.String getTitle()
```
```
 The title of the application.
 
```
string title = 1;
Specified by:

getTitle in interface Openapiv2.InfoOrBuilder

Returns:

The title.

getTitleBytes
```
public com.google.protobuf.ByteString getTitleBytes()
```
```
 The title of the application.
 
```
string title = 1;
Specified by:

getTitleBytes in interface Openapiv2.InfoOrBuilder

Returns:

The bytes for title.

getDescription

public java.lang.String getDescription()

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

string description = 2;

Specified by:: getDescription in interface Openapiv2.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;

Specified by:: getDescriptionBytes in interface Openapiv2.InfoOrBuilder
Returns:: The bytes for description.

getTermsOfService
```
public java.lang.String getTermsOfService()
```
```
 The Terms of Service for the API.
 
```
string terms_of_service = 3;
Specified by:

getTermsOfService in interface Openapiv2.InfoOrBuilder

Returns:

The termsOfService.

getTermsOfServiceBytes
```
public com.google.protobuf.ByteString getTermsOfServiceBytes()
```
```
 The Terms of Service for the API.
 
```
string terms_of_service = 3;
Specified by:

getTermsOfServiceBytes in interface Openapiv2.InfoOrBuilder

Returns:

The bytes for termsOfService.

hasContact
```
public boolean hasContact()
```
```
 The contact information for the exposed API.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;
Specified by:

hasContact in interface Openapiv2.InfoOrBuilder

Returns:

Whether the contact field is set.

getContact
```
public Openapiv2.Contact getContact()
```
```
 The contact information for the exposed API.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;
Specified by:

getContact in interface Openapiv2.InfoOrBuilder

Returns:

The contact.

getContactOrBuilder
```
public Openapiv2.ContactOrBuilder getContactOrBuilder()
```
```
 The contact information for the exposed API.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;
Specified by:

getContactOrBuilder in interface Openapiv2.InfoOrBuilder

hasLicense
```
public boolean hasLicense()
```
```
 The license information for the exposed API.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5;
Specified by:

hasLicense in interface Openapiv2.InfoOrBuilder

Returns:

Whether the license field is set.

getLicense
```
public Openapiv2.License getLicense()
```
```
 The license information for the exposed API.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5;
Specified by:

getLicense in interface Openapiv2.InfoOrBuilder

Returns:

The license.

getLicenseOrBuilder
```
public Openapiv2.LicenseOrBuilder getLicenseOrBuilder()
```
```
 The license information for the exposed API.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.License license = 5;
Specified by:

getLicenseOrBuilder in interface Openapiv2.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;

Specified by:: getVersion in interface Openapiv2.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;

Specified by:: getVersionBytes in interface Openapiv2.InfoOrBuilder
Returns:: The bytes for version.