com.grpc.gateway.protoc_gen_openapiv2.options

Class ExternalDocumentation.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation.Builder

All Implemented Interfaces:

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

Enclosing class:

ExternalDocumentation

public static final class ExternalDocumentation.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ExternalDocumentation.Builder>
implements ExternalDocumentationOrBuilder

 `ExternalDocumentation` is a representation of OpenAPI v2 specification's
 ExternalDocumentation object.

 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#externalDocumentationObject

 Example:

 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
 ...
 external_docs: {
 description: "More about gRPC-Gateway";
 url: "https://github.com/grpc-ecosystem/grpc-gateway";
 }
 ...
 };
 

Protobuf type grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation

Method Summary

Modifier and Type	Method and Description
ExternalDocumentation	build()
ExternalDocumentation	buildPartial()
ExternalDocumentation.Builder	clear()
ExternalDocumentation.Builder	clearDescription() A short description of the target documentation.
ExternalDocumentation.Builder	clearUrl() The URL for the target documentation.
ExternalDocumentation	getDefaultInstanceForType()
java.lang.String	getDescription() A short description of the target documentation.
com.google.protobuf.ByteString	getDescriptionBytes() A short description of the target documentation.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
java.lang.String	getUrl() The URL for the target documentation.
com.google.protobuf.ByteString	getUrlBytes() The URL for the target documentation.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ExternalDocumentation.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ExternalDocumentation.Builder	mergeFrom(ExternalDocumentation other)
ExternalDocumentation.Builder	mergeFrom(com.google.protobuf.Message other)
ExternalDocumentation.Builder	setDescription(java.lang.String value) A short description of the target documentation.
ExternalDocumentation.Builder	setDescriptionBytes(com.google.protobuf.ByteString value) A short description of the target documentation.
ExternalDocumentation.Builder	setUrl(java.lang.String value) The URL for the target documentation.
ExternalDocumentation.Builder	setUrlBytes(com.google.protobuf.ByteString value) The URL for the target documentation.

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, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, 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()

internalGetFieldAccessorTable

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

Specified by:

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

clear

public ExternalDocumentation.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<ExternalDocumentation.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<ExternalDocumentation.Builder>

getDefaultInstanceForType

public ExternalDocumentation getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ExternalDocumentation build()

Specified by:

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

Specified by:

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

buildPartial

public ExternalDocumentation buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

public ExternalDocumentation.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<ExternalDocumentation.Builder>

mergeFrom

public ExternalDocumentation.Builder mergeFrom(ExternalDocumentation other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom

public ExternalDocumentation.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<ExternalDocumentation.Builder>

Throws:

java.io.IOException

getDescription

public java.lang.String getDescription()

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

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

Specified by:

getDescription in interface ExternalDocumentationOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

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

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

Specified by:

getDescriptionBytes in interface ExternalDocumentationOrBuilder

Returns:

The bytes for description.

setDescription

public ExternalDocumentation.Builder setDescription(java.lang.String value)

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

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

Parameters:

value - The description to set.

Returns:

This builder for chaining.

clearDescription

public ExternalDocumentation.Builder clearDescription()

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

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

Returns:

This builder for chaining.

setDescriptionBytes

public ExternalDocumentation.Builder setDescriptionBytes(com.google.protobuf.ByteString value)

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

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

Parameters:

value - The bytes for description to set.

Returns:

This builder for chaining.

getUrl

public java.lang.String getUrl()

 The URL for the target documentation. Value MUST be in the format
 of a URL.
 

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

Specified by:

getUrl in interface ExternalDocumentationOrBuilder

Returns:

The url.

getUrlBytes

public com.google.protobuf.ByteString getUrlBytes()

 The URL for the target documentation. Value MUST be in the format
 of a URL.
 

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

Specified by:

getUrlBytes in interface ExternalDocumentationOrBuilder

Returns:

The bytes for url.

setUrl

public ExternalDocumentation.Builder setUrl(java.lang.String value)

 The URL for the target documentation. Value MUST be in the format
 of a URL.
 

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

Parameters:

value - The url to set.

Returns:

This builder for chaining.

clearUrl

public ExternalDocumentation.Builder clearUrl()

 The URL for the target documentation. Value MUST be in the format
 of a URL.
 

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

Returns:

This builder for chaining.

setUrlBytes

public ExternalDocumentation.Builder setUrlBytes(com.google.protobuf.ByteString value)

 The URL for the target documentation. Value MUST be in the format
 of a URL.
 

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

Parameters:

value - The bytes for url to set.

Returns:

This builder for chaining.