com.grpc.gateway.protoc_gen_openapiv2.options

Interface InfoOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Info, Info.Builder

public interface InfoOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and 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.
Contact	getContact() The contact information for the exposed API.
ContactOrBuilder	getContactOrBuilder() The contact information for the exposed API.
java.lang.String	getDescription() A short description of the application.
com.google.protobuf.ByteString	getDescriptionBytes() A short description of the application.
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.
LicenseOrBuilder	getLicenseOrBuilder() The license information for the exposed API.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTitle

java.lang.String getTitle()

 The title of the application.
 

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

Returns:

The title.

getTitleBytes

com.google.protobuf.ByteString getTitleBytes()

 The title of the application.
 

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

Returns:

The bytes for title.

getDescription

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

Returns:

The description.

getDescriptionBytes

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

Returns:

The bytes for description.

getTermsOfService

java.lang.String getTermsOfService()

 The Terms of Service for the API.
 

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

Returns:

The termsOfService.

getTermsOfServiceBytes

com.google.protobuf.ByteString getTermsOfServiceBytes()

 The Terms of Service for the API.
 

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

Returns:

The bytes for termsOfService.

hasContact

boolean hasContact()

 The contact information for the exposed API.
 

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

Returns:

Whether the contact field is set.

getContact

Contact getContact()

 The contact information for the exposed API.
 

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

Returns:

The contact.

getContactOrBuilder

ContactOrBuilder getContactOrBuilder()

 The contact information for the exposed API.
 

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

hasLicense

boolean hasLicense()

 The license information for the exposed API.
 

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

Returns:

Whether the license field is set.

getLicense

License getLicense()

 The license information for the exposed API.
 

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

Returns:

The license.

getLicenseOrBuilder

LicenseOrBuilder getLicenseOrBuilder()

 The license information for the exposed API.
 

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

getVersion

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

Returns:

The version.

getVersionBytes

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

Returns:

The bytes for version.

getExtensionsCount

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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 7 [json_name = "extensions"];

containsExtensions

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

getExtensions

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

Deprecated.

Use getExtensionsMap() instead.

getExtensionsMap

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

getExtensionsOrDefault

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

getExtensionsOrThrow

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