Class GetDatasetSchemaRequest (2.25.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
TypeDescription
int

VISIBLE_FIELDS_ONLY_FIELD_NUMBER

public static final int VISIBLE_FIELDS_ONLY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GetDatasetSchemaRequest getDefaultInstance()
Returns
TypeDescription
GetDatasetSchemaRequest

getDescriptor()

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

newBuilder()

public static GetDatasetSchemaRequest.Builder newBuilder()
Returns
TypeDescription
GetDatasetSchemaRequest.Builder

newBuilder(GetDatasetSchemaRequest prototype)

public static GetDatasetSchemaRequest.Builder newBuilder(GetDatasetSchemaRequest prototype)
Parameter
NameDescription
prototypeGetDatasetSchemaRequest
Returns
TypeDescription
GetDatasetSchemaRequest.Builder

parseDelimitedFrom(InputStream input)

public static GetDatasetSchemaRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GetDatasetSchemaRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static GetDatasetSchemaRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GetDatasetSchemaRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static GetDatasetSchemaRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GetDatasetSchemaRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static GetDatasetSchemaRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GetDatasetSchemaRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static GetDatasetSchemaRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GetDatasetSchemaRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<GetDatasetSchemaRequest> parser()
Returns
TypeDescription
Parser<GetDatasetSchemaRequest>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public GetDatasetSchemaRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<GetDatasetSchemaRequest> getParserForType()
Returns
TypeDescription
Parser<GetDatasetSchemaRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getVisibleFieldsOnly()

public boolean getVisibleFieldsOnly()

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

bool visible_fields_only = 2;

Returns
TypeDescription
boolean

The visibleFieldsOnly.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public GetDatasetSchemaRequest.Builder toBuilder()
Returns
TypeDescription
GetDatasetSchemaRequest.Builder

writeTo(CodedOutputStream output)

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