Class CreateDocumentRequest.Builder (0.36.0)

public static final class CreateDocumentRequest.Builder extends GeneratedMessageV3.Builder<CreateDocumentRequest.Builder> implements CreateDocumentRequestOrBuilder

Request message for DocumentService.CreateDocument.

Protobuf type google.cloud.contentwarehouse.v1.CreateDocumentRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

build()

public CreateDocumentRequest build()
Returns
TypeDescription
CreateDocumentRequest

buildPartial()

public CreateDocumentRequest buildPartial()
Returns
TypeDescription
CreateDocumentRequest

clear()

public CreateDocumentRequest.Builder clear()
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

clearCloudAiDocumentOption()

public CreateDocumentRequest.Builder clearCloudAiDocumentOption()

Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.

.google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;

Returns
TypeDescription
CreateDocumentRequest.Builder

clearCreateMask()

public CreateDocumentRequest.Builder clearCreateMask()

Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

.google.protobuf.FieldMask create_mask = 6;

Returns
TypeDescription
CreateDocumentRequest.Builder

clearDocument()

public CreateDocumentRequest.Builder clearDocument()

Required. The document to create.

.google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CreateDocumentRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public CreateDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

clearParent()

public CreateDocumentRequest.Builder clearParent()

Required. The parent name. Format: projects/{project_number}/locations/{location}.

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

Returns
TypeDescription
CreateDocumentRequest.Builder

This builder for chaining.

clearPolicy()

public CreateDocumentRequest.Builder clearPolicy()

Default document policy during creation. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. Conditions defined in the policy will be ignored.

.google.iam.v1.Policy policy = 4;

Returns
TypeDescription
CreateDocumentRequest.Builder

clearRequestMetadata()

public CreateDocumentRequest.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 = 3;

Returns
TypeDescription
CreateDocumentRequest.Builder

clone()

public CreateDocumentRequest.Builder clone()
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

getCloudAiDocumentOption()

public CloudAIDocumentOption getCloudAiDocumentOption()

Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.

.google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;

Returns
TypeDescription
CloudAIDocumentOption

The cloudAiDocumentOption.

getCloudAiDocumentOptionBuilder()

public CloudAIDocumentOption.Builder getCloudAiDocumentOptionBuilder()

Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.

.google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;

Returns
TypeDescription
CloudAIDocumentOption.Builder

getCloudAiDocumentOptionOrBuilder()

public CloudAIDocumentOptionOrBuilder getCloudAiDocumentOptionOrBuilder()

Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.

.google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;

Returns
TypeDescription
CloudAIDocumentOptionOrBuilder

getCreateMask()

public FieldMask getCreateMask()

Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

.google.protobuf.FieldMask create_mask = 6;

Returns
TypeDescription
FieldMask

The createMask.

getCreateMaskBuilder()

public FieldMask.Builder getCreateMaskBuilder()

Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

.google.protobuf.FieldMask create_mask = 6;

Returns
TypeDescription
Builder

getCreateMaskOrBuilder()

public FieldMaskOrBuilder getCreateMaskOrBuilder()

Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

.google.protobuf.FieldMask create_mask = 6;

Returns
TypeDescription
FieldMaskOrBuilder

getDefaultInstanceForType()

public CreateDocumentRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateDocumentRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDocument()

public Document getDocument()

Required. The document to create.

.google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Document

The document.

getDocumentBuilder()

public Document.Builder getDocumentBuilder()

Required. The document to create.

.google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Document.Builder

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

Required. The document to create.

.google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
DocumentOrBuilder

getParent()

public String getParent()

Required. The parent name. Format: projects/{project_number}/locations/{location}.

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent name. Format: projects/{project_number}/locations/{location}.

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

Returns
TypeDescription
ByteString

The bytes for parent.

getPolicy()

public Policy getPolicy()

Default document policy during creation. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. Conditions defined in the policy will be ignored.

.google.iam.v1.Policy policy = 4;

Returns
TypeDescription
com.google.iam.v1.Policy

The policy.

getPolicyBuilder()

public Policy.Builder getPolicyBuilder()

Default document policy during creation. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. Conditions defined in the policy will be ignored.

.google.iam.v1.Policy policy = 4;

Returns
TypeDescription
com.google.iam.v1.Policy.Builder

getPolicyOrBuilder()

public PolicyOrBuilder getPolicyOrBuilder()

Default document policy during creation. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. Conditions defined in the policy will be ignored.

.google.iam.v1.Policy policy = 4;

Returns
TypeDescription
com.google.iam.v1.PolicyOrBuilder

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 = 3;

Returns
TypeDescription
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 = 3;

Returns
TypeDescription
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 = 3;

Returns
TypeDescription
RequestMetadataOrBuilder

hasCloudAiDocumentOption()

public boolean hasCloudAiDocumentOption()

Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.

.google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;

Returns
TypeDescription
boolean

Whether the cloudAiDocumentOption field is set.

hasCreateMask()

public boolean hasCreateMask()

Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

.google.protobuf.FieldMask create_mask = 6;

Returns
TypeDescription
boolean

Whether the createMask field is set.

hasDocument()

public boolean hasDocument()

Required. The document to create.

.google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the document field is set.

hasPolicy()

public boolean hasPolicy()

Default document policy during creation. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. Conditions defined in the policy will be ignored.

.google.iam.v1.Policy policy = 4;

Returns
TypeDescription
boolean

Whether the policy field is set.

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 = 3;

Returns
TypeDescription
boolean

Whether the requestMetadata field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCloudAiDocumentOption(CloudAIDocumentOption value)

public CreateDocumentRequest.Builder mergeCloudAiDocumentOption(CloudAIDocumentOption value)

Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.

.google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;

Parameter
NameDescription
valueCloudAIDocumentOption
Returns
TypeDescription
CreateDocumentRequest.Builder

mergeCreateMask(FieldMask value)

public CreateDocumentRequest.Builder mergeCreateMask(FieldMask value)

Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

.google.protobuf.FieldMask create_mask = 6;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
CreateDocumentRequest.Builder

mergeDocument(Document value)

public CreateDocumentRequest.Builder mergeDocument(Document value)

Required. The document to create.

.google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueDocument
Returns
TypeDescription
CreateDocumentRequest.Builder

mergeFrom(CreateDocumentRequest other)

public CreateDocumentRequest.Builder mergeFrom(CreateDocumentRequest other)
Parameter
NameDescription
otherCreateDocumentRequest
Returns
TypeDescription
CreateDocumentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CreateDocumentRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

mergePolicy(Policy value)

public CreateDocumentRequest.Builder mergePolicy(Policy value)

Default document policy during creation. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. Conditions defined in the policy will be ignored.

.google.iam.v1.Policy policy = 4;

Parameter
NameDescription
valuecom.google.iam.v1.Policy
Returns
TypeDescription
CreateDocumentRequest.Builder

mergeRequestMetadata(RequestMetadata value)

public CreateDocumentRequest.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 = 3;

Parameter
NameDescription
valueRequestMetadata
Returns
TypeDescription
CreateDocumentRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

setCloudAiDocumentOption(CloudAIDocumentOption value)

public CreateDocumentRequest.Builder setCloudAiDocumentOption(CloudAIDocumentOption value)

Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.

.google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;

Parameter
NameDescription
valueCloudAIDocumentOption
Returns
TypeDescription
CreateDocumentRequest.Builder

setCloudAiDocumentOption(CloudAIDocumentOption.Builder builderForValue)

public CreateDocumentRequest.Builder setCloudAiDocumentOption(CloudAIDocumentOption.Builder builderForValue)

Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.

.google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;

Parameter
NameDescription
builderForValueCloudAIDocumentOption.Builder
Returns
TypeDescription
CreateDocumentRequest.Builder

setCreateMask(FieldMask value)

public CreateDocumentRequest.Builder setCreateMask(FieldMask value)

Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

.google.protobuf.FieldMask create_mask = 6;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
CreateDocumentRequest.Builder

setCreateMask(FieldMask.Builder builderForValue)

public CreateDocumentRequest.Builder setCreateMask(FieldMask.Builder builderForValue)

Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

.google.protobuf.FieldMask create_mask = 6;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
CreateDocumentRequest.Builder

setDocument(Document value)

public CreateDocumentRequest.Builder setDocument(Document value)

Required. The document to create.

.google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueDocument
Returns
TypeDescription
CreateDocumentRequest.Builder

setDocument(Document.Builder builderForValue)

public CreateDocumentRequest.Builder setDocument(Document.Builder builderForValue)

Required. The document to create.

.google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueDocument.Builder
Returns
TypeDescription
CreateDocumentRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CreateDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

setParent(String value)

public CreateDocumentRequest.Builder setParent(String value)

Required. The parent name. Format: projects/{project_number}/locations/{location}.

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
CreateDocumentRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateDocumentRequest.Builder setParentBytes(ByteString value)

Required. The parent name. Format: projects/{project_number}/locations/{location}.

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
CreateDocumentRequest.Builder

This builder for chaining.

setPolicy(Policy value)

public CreateDocumentRequest.Builder setPolicy(Policy value)

Default document policy during creation. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. Conditions defined in the policy will be ignored.

.google.iam.v1.Policy policy = 4;

Parameter
NameDescription
valuecom.google.iam.v1.Policy
Returns
TypeDescription
CreateDocumentRequest.Builder

setPolicy(Policy.Builder builderForValue)

public CreateDocumentRequest.Builder setPolicy(Policy.Builder builderForValue)

Default document policy during creation. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. Conditions defined in the policy will be ignored.

.google.iam.v1.Policy policy = 4;

Parameter
NameDescription
builderForValuecom.google.iam.v1.Policy.Builder
Returns
TypeDescription
CreateDocumentRequest.Builder

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

public CreateDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

setRequestMetadata(RequestMetadata value)

public CreateDocumentRequest.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 = 3;

Parameter
NameDescription
valueRequestMetadata
Returns
TypeDescription
CreateDocumentRequest.Builder

setRequestMetadata(RequestMetadata.Builder builderForValue)

public CreateDocumentRequest.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 = 3;

Parameter
NameDescription
builderForValueRequestMetadata.Builder
Returns
TypeDescription
CreateDocumentRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides