Class GetDatasetSchemaRequest (2.49.0)

public final class GetDatasetSchemaRequest extends GeneratedMessageV3 implements GetDatasetSchemaRequestOrBuilder

Request for GetDatasetSchema.

Protobuf type google.cloud.documentai.v1beta3.GetDatasetSchemaRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

VISIBLE_FIELDS_ONLY_FIELD_NUMBER

public static final int VISIBLE_FIELDS_ONLY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GetDatasetSchemaRequest getDefaultInstance()
Returns
Type Description
GetDatasetSchemaRequest

getDescriptor()

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

newBuilder()

public static GetDatasetSchemaRequest.Builder newBuilder()
Returns
Type Description
GetDatasetSchemaRequest.Builder

newBuilder(GetDatasetSchemaRequest prototype)

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

parseDelimitedFrom(InputStream input)

public static GetDatasetSchemaRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GetDatasetSchemaRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static GetDatasetSchemaRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GetDatasetSchemaRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static GetDatasetSchemaRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GetDatasetSchemaRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static GetDatasetSchemaRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GetDatasetSchemaRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static GetDatasetSchemaRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GetDatasetSchemaRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<GetDatasetSchemaRequest> parser()
Returns
Type Description
Parser<GetDatasetSchemaRequest>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public GetDatasetSchemaRequest getDefaultInstanceForType()
Returns
Type Description
GetDatasetSchemaRequest

getName()

public String getName()

Required. The dataset schema resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The dataset schema resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<GetDatasetSchemaRequest> getParserForType()
Returns
Type Description
Parser<GetDatasetSchemaRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getVisibleFieldsOnly()

public boolean getVisibleFieldsOnly()

If set, only returns the visible fields of the schema.

bool visible_fields_only = 2;

Returns
Type Description
boolean

The visibleFieldsOnly.

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 GetDatasetSchemaRequest.Builder newBuilderForType()
Returns
Type Description
GetDatasetSchemaRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public GetDatasetSchemaRequest.Builder toBuilder()
Returns
Type Description
GetDatasetSchemaRequest.Builder

writeTo(CodedOutputStream output)

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