Class GetDatasetSchemaRequest.Builder (2.87.0)

public static final class GetDatasetSchemaRequest.Builder extends GeneratedMessage.Builder<GetDatasetSchemaRequest.Builder> implements GetDatasetSchemaRequestOrBuilder

Request for GetDatasetSchema.

Protobuf type google.cloud.documentai.v1beta3.GetDatasetSchemaRequest

Static Methods

getDescriptor()

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

Methods

build()

public GetDatasetSchemaRequest build()
Returns
Type Description
GetDatasetSchemaRequest

buildPartial()

public GetDatasetSchemaRequest buildPartial()
Returns
Type Description
GetDatasetSchemaRequest

clear()

public GetDatasetSchemaRequest.Builder clear()
Returns
Type Description
GetDatasetSchemaRequest.Builder
Overrides

clearName()

public GetDatasetSchemaRequest.Builder clearName()

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
GetDatasetSchemaRequest.Builder

This builder for chaining.

clearVisibleFieldsOnly()

public GetDatasetSchemaRequest.Builder clearVisibleFieldsOnly()

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

bool visible_fields_only = 2;

Returns
Type Description
GetDatasetSchemaRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public GetDatasetSchemaRequest getDefaultInstanceForType()
Returns
Type Description
GetDatasetSchemaRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GetDatasetSchemaRequest other)

public GetDatasetSchemaRequest.Builder mergeFrom(GetDatasetSchemaRequest other)
Parameter
Name Description
other GetDatasetSchemaRequest
Returns
Type Description
GetDatasetSchemaRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GetDatasetSchemaRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetDatasetSchemaRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GetDatasetSchemaRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GetDatasetSchemaRequest.Builder
Overrides

setName(String value)

public GetDatasetSchemaRequest.Builder setName(String value)

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) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
GetDatasetSchemaRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GetDatasetSchemaRequest.Builder setNameBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
GetDatasetSchemaRequest.Builder

This builder for chaining.

setVisibleFieldsOnly(boolean value)

public GetDatasetSchemaRequest.Builder setVisibleFieldsOnly(boolean value)

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

bool visible_fields_only = 2;

Parameter
Name Description
value boolean

The visibleFieldsOnly to set.

Returns
Type Description
GetDatasetSchemaRequest.Builder

This builder for chaining.