Class ApiConfig.OpenApiDocument (2.41.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
Type Description
int

Static Methods

getDefaultInstance()

public static ApiConfig.OpenApiDocument getDefaultInstance()
Returns
Type Description
ApiConfig.OpenApiDocument

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ApiConfig.OpenApiDocument.Builder newBuilder()
Returns
Type Description
ApiConfig.OpenApiDocument.Builder

newBuilder(ApiConfig.OpenApiDocument prototype)

public static ApiConfig.OpenApiDocument.Builder newBuilder(ApiConfig.OpenApiDocument prototype)
Parameter
Name Description
prototype ApiConfig.OpenApiDocument
Returns
Type Description
ApiConfig.OpenApiDocument.Builder

parseDelimitedFrom(InputStream input)

public static ApiConfig.OpenApiDocument parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ApiConfig.OpenApiDocument
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ApiConfig.OpenApiDocument parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfig.OpenApiDocument
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ApiConfig.OpenApiDocument parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ApiConfig.OpenApiDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ApiConfig.OpenApiDocument parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfig.OpenApiDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ApiConfig.OpenApiDocument parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ApiConfig.OpenApiDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ApiConfig.OpenApiDocument parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfig.OpenApiDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ApiConfig.OpenApiDocument parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ApiConfig.OpenApiDocument
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ApiConfig.OpenApiDocument parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfig.OpenApiDocument
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ApiConfig.OpenApiDocument parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ApiConfig.OpenApiDocument
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ApiConfig.OpenApiDocument parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfig.OpenApiDocument
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ApiConfig.OpenApiDocument parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ApiConfig.OpenApiDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ApiConfig.OpenApiDocument parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiConfig.OpenApiDocument
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ApiConfig.OpenApiDocument getDefaultInstanceForType()
Returns
Type Description
ApiConfig.OpenApiDocument

getDocument()

public ApiConfig.File getDocument()

The OpenAPI Specification document file.

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

Returns
Type Description
ApiConfig.File

The document.

getDocumentOrBuilder()

public ApiConfig.FileOrBuilder getDocumentOrBuilder()

The OpenAPI Specification document file.

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

Returns
Type Description
ApiConfig.FileOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDocument()

public boolean hasDocument()

The OpenAPI Specification document file.

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

Returns
Type Description
boolean

Whether the document field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ApiConfig.OpenApiDocument.Builder newBuilderForType()
Returns
Type Description
ApiConfig.OpenApiDocument.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ApiConfig.OpenApiDocument.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ApiConfig.OpenApiDocument.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ApiConfig.OpenApiDocument.Builder toBuilder()
Returns
Type Description
ApiConfig.OpenApiDocument.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException