Class CreateDocumentRequest (0.31.0)

public final class CreateDocumentRequest extends GeneratedMessageV3 implements CreateDocumentRequestOrBuilder

Request message for DocumentService.CreateDocument.

Protobuf type google.cloud.contentwarehouse.v1.CreateDocumentRequest

Static Fields

CLOUD_AI_DOCUMENT_OPTION_FIELD_NUMBER

public static final int CLOUD_AI_DOCUMENT_OPTION_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_MASK_FIELD_NUMBER

public static final int CREATE_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

POLICY_FIELD_NUMBER

public static final int POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_METADATA_FIELD_NUMBER

public static final int REQUEST_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateDocumentRequest getDefaultInstance()
Returns
TypeDescription
CreateDocumentRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateDocumentRequest prototype)

public static CreateDocumentRequest.Builder newBuilder(CreateDocumentRequest prototype)
Parameter
NameDescription
prototypeCreateDocumentRequest
Returns
TypeDescription
CreateDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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.

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.

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

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.

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.

getParserForType()

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

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.

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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