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.GeneratedMessageV3.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, Cloneable

Enclosing class:

ExternalDocumentation

public static final class ExternalDocumentation.Builder
extends com.google.protobuf.GeneratedMessageV3.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.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ExternalDocumentation	build()
ExternalDocumentation	buildPartial()
ExternalDocumentation.Builder	clear()
ExternalDocumentation.Builder	clearDescription() A short description of the target documentation.
ExternalDocumentation.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ExternalDocumentation.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ExternalDocumentation.Builder	clearUrl() The URL for the target documentation.
ExternalDocumentation.Builder	clone()
ExternalDocumentation	getDefaultInstanceForType()
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()
String	getUrl() The URL for the target documentation.
com.google.protobuf.ByteString	getUrlBytes() The URL for the target documentation.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
ExternalDocumentation.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ExternalDocumentation.Builder	setDescription(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	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ExternalDocumentation.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ExternalDocumentation.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ExternalDocumentation.Builder	setUrl(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.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, isInitialized, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, 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.MessageLiteOrBuilder

isInitialized

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.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

clone

public ExternalDocumentation.Builder clone()

Specified by:

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

Specified by:

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

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ExternalDocumentation.Builder>

setField

public ExternalDocumentation.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:

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

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExternalDocumentation.Builder>

clearField

public ExternalDocumentation.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

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

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExternalDocumentation.Builder>

clearOneof

public ExternalDocumentation.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

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

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExternalDocumentation.Builder>

setRepeatedField

public ExternalDocumentation.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)

Specified by:

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

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExternalDocumentation.Builder>

addRepeatedField

public ExternalDocumentation.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:

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

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExternalDocumentation.Builder>

getDescription

public 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(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 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(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.

setUnknownFields

public final ExternalDocumentation.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

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

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExternalDocumentation.Builder>

mergeUnknownFields

public final ExternalDocumentation.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

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

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExternalDocumentation.Builder>