Openapiv2.Response (pinecone-java-client 0.2.1 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Response

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.ResponseOrBuilder, java.io.Serializable

Enclosing class:

Openapiv2
```
public static final class Openapiv2.Response
extends com.google.protobuf.GeneratedMessageV3
implements Openapiv2.ResponseOrBuilder
```
```
 `Response` is a representation of OpenAPI v2 specification's Response object.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject
 
```
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Response
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Openapiv2.Response.Builder
`Response` is a representation of OpenAPI v2 specification's Response object.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`Openapiv2.Response.Builder` `Response` is a representation of OpenAPI v2 specification's Response object.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`EXAMPLES_FIELD_NUMBER`
`static int`	`EXTENSIONS_FIELD_NUMBER`
`static int`	`HEADERS_FIELD_NUMBER`
`static int`	`SCHEMA_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsExamples(java.lang.String key)` `Examples` gives per-mimetype response examples.
`boolean`	`containsExtensions(java.lang.String key)` `map<string, .google.protobuf.Value> extensions = 5;`
`boolean`	`containsHeaders(java.lang.String key)` `Headers` A list of headers that are sent with the response.
`boolean`	`equals(java.lang.Object obj)`
`static Openapiv2.Response`	`getDefaultInstance()`
`Openapiv2.Response`	`getDefaultInstanceForType()`
`java.lang.String`	`getDescription()` `Description` is a short description of the response.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` `Description` is a short description of the response.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`java.util.Map<java.lang.String,java.lang.String>`	`getExamples()` Deprecated.
`int`	`getExamplesCount()` `Examples` gives per-mimetype response examples.
`java.util.Map<java.lang.String,java.lang.String>`	`getExamplesMap()` `Examples` gives per-mimetype response examples.
`java.lang.String`	`getExamplesOrDefault(java.lang.String key, java.lang.String defaultValue)` `Examples` gives per-mimetype response examples.
`java.lang.String`	`getExamplesOrThrow(java.lang.String key)` `Examples` gives per-mimetype response examples.
`java.util.Map<java.lang.String,com.google.protobuf.Value>`	`getExtensions()` Deprecated.
`int`	`getExtensionsCount()` `map<string, .google.protobuf.Value> extensions = 5;`
`java.util.Map<java.lang.String,com.google.protobuf.Value>`	`getExtensionsMap()` `map<string, .google.protobuf.Value> extensions = 5;`
`com.google.protobuf.Value`	`getExtensionsOrDefault(java.lang.String key, com.google.protobuf.Value defaultValue)` `map<string, .google.protobuf.Value> extensions = 5;`
`com.google.protobuf.Value`	`getExtensionsOrThrow(java.lang.String key)` `map<string, .google.protobuf.Value> extensions = 5;`
`java.util.Map<java.lang.String,Openapiv2.Header>`	`getHeaders()` Deprecated.
`int`	`getHeadersCount()` `Headers` A list of headers that are sent with the response.
`java.util.Map<java.lang.String,Openapiv2.Header>`	`getHeadersMap()` `Headers` A list of headers that are sent with the response.
`Openapiv2.Header`	`getHeadersOrDefault(java.lang.String key, Openapiv2.Header defaultValue)` `Headers` A list of headers that are sent with the response.
`Openapiv2.Header`	`getHeadersOrThrow(java.lang.String key)` `Headers` A list of headers that are sent with the response.
`com.google.protobuf.Parser<Openapiv2.Response>`	`getParserForType()`
`Openapiv2.Schema`	`getSchema()` `Schema` optionally defines the structure of the response.
`Openapiv2.SchemaOrBuilder`	`getSchemaOrBuilder()` `Schema` optionally defines the structure of the response.
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`boolean`	`hasSchema()` `Schema` optionally defines the structure of the response.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static Openapiv2.Response.Builder`	`newBuilder()`
`static Openapiv2.Response.Builder`	`newBuilder(Openapiv2.Response prototype)`
`Openapiv2.Response.Builder`	`newBuilderForType()`
`protected Openapiv2.Response.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected java.lang.Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Openapiv2.Response`	`parseDelimitedFrom(java.io.InputStream input)`
`static Openapiv2.Response`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openapiv2.Response`	`parseFrom(byte[] data)`
`static Openapiv2.Response`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openapiv2.Response`	`parseFrom(java.nio.ByteBuffer data)`
`static Openapiv2.Response`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openapiv2.Response`	`parseFrom(com.google.protobuf.ByteString data)`
`static Openapiv2.Response`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openapiv2.Response`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Openapiv2.Response`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openapiv2.Response`	`parseFrom(java.io.InputStream input)`
`static Openapiv2.Response`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Openapiv2.Response>`	`parser()`
`Openapiv2.Response.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SCHEMA_FIELD_NUMBER
```
public static final int SCHEMA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HEADERS_FIELD_NUMBER
```
public static final int HEADERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXAMPLES_FIELD_NUMBER
```
public static final int EXAMPLES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXTENSIONS_FIELD_NUMBER
```
public static final int EXTENSIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getDescription

public java.lang.String getDescription()

 `Description` is a short description of the response.
 GFM syntax can be used for rich text representation.

string description = 1;

Specified by:: getDescription in interface Openapiv2.ResponseOrBuilder
Returns:: The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 `Description` is a short description of the response.
 GFM syntax can be used for rich text representation.

string description = 1;

Specified by:: getDescriptionBytes in interface Openapiv2.ResponseOrBuilder
Returns:: The bytes for description.

hasSchema
```
public boolean hasSchema()
```
```
 `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;
Specified by:

hasSchema in interface Openapiv2.ResponseOrBuilder

Returns:

Whether the schema field is set.

getSchema

public Openapiv2.Schema getSchema()

 `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.

.grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;

Specified by:: getSchema in interface Openapiv2.ResponseOrBuilder
Returns:: The schema.

getSchemaOrBuilder

public Openapiv2.SchemaOrBuilder getSchemaOrBuilder()

 `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.

.grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;

Specified by:: getSchemaOrBuilder in interface Openapiv2.ResponseOrBuilder

getHeadersCount

public int getHeadersCount()

Description copied from interface: Openapiv2.ResponseOrBuilder

 `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey

map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

Specified by:: getHeadersCount in interface Openapiv2.ResponseOrBuilder

containsHeaders

public boolean containsHeaders(java.lang.String key)

 `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey

map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

Specified by:: containsHeaders in interface Openapiv2.ResponseOrBuilder

getHeaders
```
@Deprecated
public java.util.Map<java.lang.String,Openapiv2.Header> getHeaders()
```
Deprecated.

Use getHeadersMap() instead.

Specified by:

getHeaders in interface Openapiv2.ResponseOrBuilder

getHeadersMap

public java.util.Map<java.lang.String,Openapiv2.Header> getHeadersMap()

 `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey

map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

Specified by:: getHeadersMap in interface Openapiv2.ResponseOrBuilder

getHeadersOrDefault

public Openapiv2.Header getHeadersOrDefault(java.lang.String key,
                                            Openapiv2.Header defaultValue)

 `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey

map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

Specified by:: getHeadersOrDefault in interface Openapiv2.ResponseOrBuilder

getHeadersOrThrow

public Openapiv2.Header getHeadersOrThrow(java.lang.String key)

 `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey

map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

Specified by:: getHeadersOrThrow in interface Openapiv2.ResponseOrBuilder