Openapiv2.ExternalDocumentation.Builder (pinecone-java-client 0.2.1 API)

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, java.lang.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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Openapiv2.ExternalDocumentation.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`Openapiv2.ExternalDocumentation`	`build()`
`Openapiv2.ExternalDocumentation`	`buildPartial()`
`Openapiv2.ExternalDocumentation.Builder`	`clear()`
`Openapiv2.ExternalDocumentation.Builder`	`clearDescription()` A short description of the target documentation.
`Openapiv2.ExternalDocumentation.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Openapiv2.ExternalDocumentation.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Openapiv2.ExternalDocumentation.Builder`	`clearUrl()` The URL for the target documentation.
`Openapiv2.ExternalDocumentation.Builder`	`clone()`
`Openapiv2.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.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Openapiv2.ExternalDocumentation.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Openapiv2.ExternalDocumentation.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Openapiv2.ExternalDocumentation.Builder`	`mergeFrom(Openapiv2.ExternalDocumentation other)`
`Openapiv2.ExternalDocumentation.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Openapiv2.ExternalDocumentation.Builder`	`setDescription(java.lang.String value)` A short description of the target documentation.
`Openapiv2.ExternalDocumentation.Builder`	`setDescriptionBytes(com.google.protobuf.ByteString value)` A short description of the target documentation.
`Openapiv2.ExternalDocumentation.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`Openapiv2.ExternalDocumentation.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`Openapiv2.ExternalDocumentation.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Openapiv2.ExternalDocumentation.Builder`	`setUrl(java.lang.String value)` The URL for the target documentation.
`Openapiv2.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, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, 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.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- 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<Openapiv2.ExternalDocumentation.Builder>
  - clear
```
public Openapiv2.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<Openapiv2.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<Openapiv2.ExternalDocumentation.Builder>
  - getDefaultInstanceForType
```
public Openapiv2.ExternalDocumentation getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Openapiv2.ExternalDocumentation build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Openapiv2.ExternalDocumentation buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Openapiv2.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<Openapiv2.ExternalDocumentation.Builder>
  - setField
```
public Openapiv2.ExternalDocumentation.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        java.lang.Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
  - clearField
```
public Openapiv2.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<Openapiv2.ExternalDocumentation.Builder>
  - clearOneof
```
public Openapiv2.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<Openapiv2.ExternalDocumentation.Builder>
  - setRepeatedField
```
public Openapiv2.ExternalDocumentation.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                int index,
                                                                java.lang.Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
  - addRepeatedField
```
public Openapiv2.ExternalDocumentation.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                java.lang.Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
  - mergeFrom
```
public Openapiv2.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<Openapiv2.ExternalDocumentation.Builder>
  - mergeFrom
```
public Openapiv2.ExternalDocumentation.Builder mergeFrom(Openapiv2.ExternalDocumentation other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
  - mergeFrom
```
public Openapiv2.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<Openapiv2.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;
    Specified by:
    
    getDescription in interface Openapiv2.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 interface Openapiv2.ExternalDocumentationOrBuilder
    
    Returns:
    
    The bytes for description.
  - setDescription
```
public Openapiv2.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;
    Parameters:
    
    value - The description to set.
    
    Returns:
    
    This builder for chaining.
  - clearDescription
```
public Openapiv2.ExternalDocumentation.Builder 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
```
public java.lang.String getUrl()
```
```
 The URL for the target documentation. Value MUST be in the format
 of a URL.
 
```
    string url = 2;
    Specified by:
    
    getUrl in interface Openapiv2.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 interface Openapiv2.ExternalDocumentationOrBuilder
    
    Returns:
    
    The bytes for url.
  - setUrl
```
public Openapiv2.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;
    Parameters:
    
    value - The url to set.
    
    Returns:
    
    This builder for chaining.
  - clearUrl
```
public Openapiv2.ExternalDocumentation.Builder 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
```
public Openapiv2.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;
    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 interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
  - mergeUnknownFields
```
public final Openapiv2.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<Openapiv2.ExternalDocumentation.Builder>

Class Openapiv2.ExternalDocumentation.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getDescription

getDescriptionBytes

setDescription

clearDescription

setDescriptionBytes

getUrl

getUrlBytes

setUrl

clearUrl

setUrlBytes

setUnknownFields

mergeUnknownFields