Class GetDocumentRequest.Builder (0.47.0)

public static final class GetDocumentRequest.Builder extends GeneratedMessageV3.Builder<GetDocumentRequest.Builder> implements GetDocumentRequestOrBuilder

Request message for DocumentService.GetDocument.

Protobuf type google.cloud.contentwarehouse.v1.GetDocumentRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GetDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GetDocumentRequest.Builder
Overrides

build()

public GetDocumentRequest build()
Returns
Type Description
GetDocumentRequest

buildPartial()

public GetDocumentRequest buildPartial()
Returns
Type Description
GetDocumentRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

public GetDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GetDocumentRequest.Builder
Overrides

clearName()

public GetDocumentRequest.Builder clearName()

Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

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

Returns
Type Description
GetDocumentRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GetDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GetDocumentRequest.Builder
Overrides

clearRequestMetadata()

public GetDocumentRequest.Builder clearRequestMetadata()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 2;

Returns
Type Description
GetDocumentRequest.Builder

clone()

public GetDocumentRequest.Builder clone()
Returns
Type Description
GetDocumentRequest.Builder
Overrides

getDefaultInstanceForType()

public GetDocumentRequest getDefaultInstanceForType()
Returns
Type Description
GetDocumentRequest

getDescriptorForType()

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

getName()

public String getName()

Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

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

Returns
Type Description
ByteString

The bytes for name.

getRequestMetadata()

public RequestMetadata getRequestMetadata()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 2;

Returns
Type Description
RequestMetadata

The requestMetadata.

getRequestMetadataBuilder()

public RequestMetadata.Builder getRequestMetadataBuilder()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 2;

Returns
Type Description
RequestMetadata.Builder

getRequestMetadataOrBuilder()

public RequestMetadataOrBuilder getRequestMetadataOrBuilder()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 2;

Returns
Type Description
RequestMetadataOrBuilder

hasRequestMetadata()

public boolean hasRequestMetadata()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 2;

Returns
Type Description
boolean

Whether the requestMetadata field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GetDocumentRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRequestMetadata(RequestMetadata value)

public GetDocumentRequest.Builder mergeRequestMetadata(RequestMetadata value)

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 2;

Parameter
Name Description
value RequestMetadata
Returns
Type Description
GetDocumentRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GetDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GetDocumentRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public GetDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GetDocumentRequest.Builder
Overrides

setName(String value)

public GetDocumentRequest.Builder setName(String value)

Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
GetDocumentRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GetDocumentRequest.Builder setNameBytes(ByteString value)

Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

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

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GetDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GetDocumentRequest.Builder
Overrides

setRequestMetadata(RequestMetadata value)

public GetDocumentRequest.Builder setRequestMetadata(RequestMetadata value)

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 2;

Parameter
Name Description
value RequestMetadata
Returns
Type Description
GetDocumentRequest.Builder

setRequestMetadata(RequestMetadata.Builder builderForValue)

public GetDocumentRequest.Builder setRequestMetadata(RequestMetadata.Builder builderForValue)

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 2;

Parameter
Name Description
builderForValue RequestMetadata.Builder
Returns
Type Description
GetDocumentRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final GetDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GetDocumentRequest.Builder
Overrides