Class ApiConfig.OpenApiDocument (2.27.0)

public static final class ApiConfig.OpenApiDocument extends GeneratedMessageV3 implements ApiConfig.OpenApiDocumentOrBuilder

An OpenAPI Specification Document describing an API.

Protobuf type google.cloud.apigateway.v1.ApiConfig.OpenApiDocument

Static Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ApiConfig.OpenApiDocument getDefaultInstance()
Returns
TypeDescription
ApiConfig.OpenApiDocument

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ApiConfig.OpenApiDocument.Builder newBuilder()
Returns
TypeDescription
ApiConfig.OpenApiDocument.Builder

newBuilder(ApiConfig.OpenApiDocument prototype)

public static ApiConfig.OpenApiDocument.Builder newBuilder(ApiConfig.OpenApiDocument prototype)
Parameter
NameDescription
prototypeApiConfig.OpenApiDocument
Returns
TypeDescription
ApiConfig.OpenApiDocument.Builder

parseDelimitedFrom(InputStream input)

public static ApiConfig.OpenApiDocument parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ApiConfig.OpenApiDocument
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ApiConfig.OpenApiDocument parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ApiConfig.OpenApiDocument
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ApiConfig.OpenApiDocument parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ApiConfig.OpenApiDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ApiConfig.OpenApiDocument parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ApiConfig.OpenApiDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ApiConfig.OpenApiDocument parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ApiConfig.OpenApiDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ApiConfig.OpenApiDocument parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ApiConfig.OpenApiDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ApiConfig.OpenApiDocument parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ApiConfig.OpenApiDocument
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ApiConfig.OpenApiDocument parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ApiConfig.OpenApiDocument
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ApiConfig.OpenApiDocument parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ApiConfig.OpenApiDocument
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ApiConfig.OpenApiDocument parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ApiConfig.OpenApiDocument
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ApiConfig.OpenApiDocument parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ApiConfig.OpenApiDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ApiConfig.OpenApiDocument parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ApiConfig.OpenApiDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ApiConfig.OpenApiDocument> parser()
Returns
TypeDescription
Parser<OpenApiDocument>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ApiConfig.OpenApiDocument getDefaultInstanceForType()
Returns
TypeDescription
ApiConfig.OpenApiDocument

getDocument()

public ApiConfig.File getDocument()

The OpenAPI Specification document file.

.google.cloud.apigateway.v1.ApiConfig.File document = 1;

Returns
TypeDescription
ApiConfig.File

The document.

getDocumentOrBuilder()

public ApiConfig.FileOrBuilder getDocumentOrBuilder()

The OpenAPI Specification document file.

.google.cloud.apigateway.v1.ApiConfig.File document = 1;

Returns
TypeDescription
ApiConfig.FileOrBuilder

getParserForType()

public Parser<ApiConfig.OpenApiDocument> getParserForType()
Returns
TypeDescription
Parser<OpenApiDocument>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasDocument()

public boolean hasDocument()

The OpenAPI Specification document file.

.google.cloud.apigateway.v1.ApiConfig.File document = 1;

Returns
TypeDescription
boolean

Whether the document field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ApiConfig.OpenApiDocument.Builder newBuilderForType()
Returns
TypeDescription
ApiConfig.OpenApiDocument.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ApiConfig.OpenApiDocument.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ApiConfig.OpenApiDocument.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ApiConfig.OpenApiDocument.Builder toBuilder()
Returns
TypeDescription
ApiConfig.OpenApiDocument.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException