Class Openapiv2.ExternalDocumentation.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.ExternalDocumentation.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Openapiv2.ExternalDocumentationOrBuilder
,Cloneable
- Enclosing class:
- Openapiv2.ExternalDocumentation
public static final class Openapiv2.ExternalDocumentation.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
implements Openapiv2.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 TypeMethodDescriptionaddRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
A short description of the target documentation.clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) clearUrl()
The URL for the target documentation.clone()
A short description of the target documentation.com.google.protobuf.ByteString
A short description of the target documentation.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
getUrl()
The URL for the target documentation.com.google.protobuf.ByteString
The URL for the target documentation.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) setDescription
(String value) A short description of the target documentation.setDescriptionBytes
(com.google.protobuf.ByteString value) A short description of the target documentation.setRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) The URL for the target documentation.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, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
-
setField
public Openapiv2.ExternalDocumentation.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
-
clearField
public Openapiv2.ExternalDocumentation.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
-
clearOneof
public Openapiv2.ExternalDocumentation.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
-
setRepeatedField
public Openapiv2.ExternalDocumentation.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
-
addRepeatedField
public Openapiv2.ExternalDocumentation.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Openapiv2.ExternalDocumentation.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
-
mergeFrom
public Openapiv2.ExternalDocumentation.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Openapiv2.ExternalDocumentation.Builder>
- Throws:
IOException
-
getDescription
A short description of the target documentation. GFM syntax can be used for rich text representation.
string description = 1;
- Specified by:
getDescription
in interfaceOpenapiv2.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;
- Specified by:
getDescriptionBytes
in interfaceOpenapiv2.ExternalDocumentationOrBuilder
- Returns:
- The bytes for description.
-
setDescription
A short description of the target documentation. GFM syntax can be used for rich text representation.
string description = 1;
- Parameters:
value
- The description to set.- Returns:
- This builder for chaining.
-
clearDescription
A short description of the target documentation. GFM syntax can be used for rich text representation.
string description = 1;
- Returns:
- This builder for chaining.
-
setDescriptionBytes
public Openapiv2.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;
- Parameters:
value
- The bytes for description to set.- Returns:
- This builder for chaining.
-
getUrl
The URL for the target documentation. Value MUST be in the format of a URL.
string url = 2;
- Specified by:
getUrl
in interfaceOpenapiv2.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;
- Specified by:
getUrlBytes
in interfaceOpenapiv2.ExternalDocumentationOrBuilder
- Returns:
- The bytes for url.
-
setUrl
The URL for the target documentation. Value MUST be in the format of a URL.
string url = 2;
- Parameters:
value
- The url to set.- Returns:
- This builder for chaining.
-
clearUrl
The URL for the target documentation. Value MUST be in the format of a URL.
string url = 2;
- Returns:
- This builder for chaining.
-
setUrlBytes
The URL for the target documentation. Value MUST be in the format of a URL.
string url = 2;
- Parameters:
value
- The bytes for url to set.- Returns:
- This builder for chaining.
-
setUnknownFields
public final Openapiv2.ExternalDocumentation.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
-
mergeUnknownFields
public final Openapiv2.ExternalDocumentation.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
-