Class RunPipelineMetadata (0.42.0)

public final class RunPipelineMetadata extends GeneratedMessageV3 implements RunPipelineMetadataOrBuilder

Metadata message of RunPipeline method.

Protobuf type google.cloud.contentwarehouse.v1.RunPipelineMetadata

Static Fields

EXPORT_TO_CDW_PIPELINE_METADATA_FIELD_NUMBER

public static final int EXPORT_TO_CDW_PIPELINE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

FAILED_FILE_COUNT_FIELD_NUMBER

public static final int FAILED_FILE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

GCS_INGEST_PIPELINE_METADATA_FIELD_NUMBER

public static final int GCS_INGEST_PIPELINE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

INDIVIDUAL_DOCUMENT_STATUSES_FIELD_NUMBER

public static final int INDIVIDUAL_DOCUMENT_STATUSES_FIELD_NUMBER
Field Value
Type Description
int

PROCESS_WITH_DOC_AI_PIPELINE_METADATA_FIELD_NUMBER

public static final int PROCESS_WITH_DOC_AI_PIPELINE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_FILE_COUNT_FIELD_NUMBER

public static final int TOTAL_FILE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

USER_INFO_FIELD_NUMBER

public static final int USER_INFO_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RunPipelineMetadata getDefaultInstance()
Returns
Type Description
RunPipelineMetadata

getDescriptor()

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

newBuilder()

public static RunPipelineMetadata.Builder newBuilder()
Returns
Type Description
RunPipelineMetadata.Builder

newBuilder(RunPipelineMetadata prototype)

public static RunPipelineMetadata.Builder newBuilder(RunPipelineMetadata prototype)
Parameter
Name Description
prototype RunPipelineMetadata
Returns
Type Description
RunPipelineMetadata.Builder

parseDelimitedFrom(InputStream input)

public static RunPipelineMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunPipelineMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunPipelineMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RunPipelineMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RunPipelineMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunPipelineMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunPipelineMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RunPipelineMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunPipelineMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunPipelineMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RunPipelineMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunPipelineMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RunPipelineMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunPipelineMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunPipelineMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RunPipelineMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RunPipelineMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunPipelineMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RunPipelineMetadata> parser()
Returns
Type Description
Parser<RunPipelineMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public RunPipelineMetadata getDefaultInstanceForType()
Returns
Type Description
RunPipelineMetadata

getExportToCdwPipelineMetadata()

public RunPipelineMetadata.ExportToCdwPipelineMetadata getExportToCdwPipelineMetadata()

The pipeline metadata for Export-to-CDW pipeline.

.google.cloud.contentwarehouse.v1.RunPipelineMetadata.ExportToCdwPipelineMetadata export_to_cdw_pipeline_metadata = 6;

Returns
Type Description
RunPipelineMetadata.ExportToCdwPipelineMetadata

The exportToCdwPipelineMetadata.

getExportToCdwPipelineMetadataOrBuilder()

public RunPipelineMetadata.ExportToCdwPipelineMetadataOrBuilder getExportToCdwPipelineMetadataOrBuilder()

The pipeline metadata for Export-to-CDW pipeline.

.google.cloud.contentwarehouse.v1.RunPipelineMetadata.ExportToCdwPipelineMetadata export_to_cdw_pipeline_metadata = 6;

Returns
Type Description
RunPipelineMetadata.ExportToCdwPipelineMetadataOrBuilder

getFailedFileCount()

public int getFailedFileCount()

Number of files that have failed at some point in the pipeline.

int32 failed_file_count = 2;

Returns
Type Description
int

The failedFileCount.

getGcsIngestPipelineMetadata()

public RunPipelineMetadata.GcsIngestPipelineMetadata getGcsIngestPipelineMetadata()

The pipeline metadata for GcsIngest pipeline.

.google.cloud.contentwarehouse.v1.RunPipelineMetadata.GcsIngestPipelineMetadata gcs_ingest_pipeline_metadata = 4;

Returns
Type Description
RunPipelineMetadata.GcsIngestPipelineMetadata

The gcsIngestPipelineMetadata.

getGcsIngestPipelineMetadataOrBuilder()

public RunPipelineMetadata.GcsIngestPipelineMetadataOrBuilder getGcsIngestPipelineMetadataOrBuilder()

The pipeline metadata for GcsIngest pipeline.

.google.cloud.contentwarehouse.v1.RunPipelineMetadata.GcsIngestPipelineMetadata gcs_ingest_pipeline_metadata = 4;

Returns
Type Description
RunPipelineMetadata.GcsIngestPipelineMetadataOrBuilder

getIndividualDocumentStatuses(int index)

public RunPipelineMetadata.IndividualDocumentStatus getIndividualDocumentStatuses(int index)

The list of response details of each document.

repeated .google.cloud.contentwarehouse.v1.RunPipelineMetadata.IndividualDocumentStatus individual_document_statuses = 5;

Parameter
Name Description
index int
Returns
Type Description
RunPipelineMetadata.IndividualDocumentStatus

getIndividualDocumentStatusesCount()

public int getIndividualDocumentStatusesCount()

The list of response details of each document.

repeated .google.cloud.contentwarehouse.v1.RunPipelineMetadata.IndividualDocumentStatus individual_document_statuses = 5;

Returns
Type Description
int

getIndividualDocumentStatusesList()

public List<RunPipelineMetadata.IndividualDocumentStatus> getIndividualDocumentStatusesList()

The list of response details of each document.

repeated .google.cloud.contentwarehouse.v1.RunPipelineMetadata.IndividualDocumentStatus individual_document_statuses = 5;

Returns
Type Description
List<IndividualDocumentStatus>

getIndividualDocumentStatusesOrBuilder(int index)

public RunPipelineMetadata.IndividualDocumentStatusOrBuilder getIndividualDocumentStatusesOrBuilder(int index)

The list of response details of each document.

repeated .google.cloud.contentwarehouse.v1.RunPipelineMetadata.IndividualDocumentStatus individual_document_statuses = 5;

Parameter
Name Description
index int
Returns
Type Description
RunPipelineMetadata.IndividualDocumentStatusOrBuilder

getIndividualDocumentStatusesOrBuilderList()

public List<? extends RunPipelineMetadata.IndividualDocumentStatusOrBuilder> getIndividualDocumentStatusesOrBuilderList()

The list of response details of each document.

repeated .google.cloud.contentwarehouse.v1.RunPipelineMetadata.IndividualDocumentStatus individual_document_statuses = 5;

Returns
Type Description
List<? extends com.google.cloud.contentwarehouse.v1.RunPipelineMetadata.IndividualDocumentStatusOrBuilder>

getParserForType()

public Parser<RunPipelineMetadata> getParserForType()
Returns
Type Description
Parser<RunPipelineMetadata>
Overrides

getPipelineMetadataCase()

public RunPipelineMetadata.PipelineMetadataCase getPipelineMetadataCase()
Returns
Type Description
RunPipelineMetadata.PipelineMetadataCase

getProcessWithDocAiPipelineMetadata()

public RunPipelineMetadata.ProcessWithDocAiPipelineMetadata getProcessWithDocAiPipelineMetadata()

The pipeline metadata for Process-with-DocAi pipeline.

.google.cloud.contentwarehouse.v1.RunPipelineMetadata.ProcessWithDocAiPipelineMetadata process_with_doc_ai_pipeline_metadata = 7;

Returns
Type Description
RunPipelineMetadata.ProcessWithDocAiPipelineMetadata

The processWithDocAiPipelineMetadata.

getProcessWithDocAiPipelineMetadataOrBuilder()

public RunPipelineMetadata.ProcessWithDocAiPipelineMetadataOrBuilder getProcessWithDocAiPipelineMetadataOrBuilder()

The pipeline metadata for Process-with-DocAi pipeline.

.google.cloud.contentwarehouse.v1.RunPipelineMetadata.ProcessWithDocAiPipelineMetadata process_with_doc_ai_pipeline_metadata = 7;

Returns
Type Description
RunPipelineMetadata.ProcessWithDocAiPipelineMetadataOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalFileCount()

public int getTotalFileCount()

Number of files that were processed by the pipeline.

int32 total_file_count = 1;

Returns
Type Description
int

The totalFileCount.

getUserInfo()

public UserInfo getUserInfo()

User unique identification and groups information.

.google.cloud.contentwarehouse.v1.UserInfo user_info = 3;

Returns
Type Description
UserInfo

The userInfo.

getUserInfoOrBuilder()

public UserInfoOrBuilder getUserInfoOrBuilder()

User unique identification and groups information.

.google.cloud.contentwarehouse.v1.UserInfo user_info = 3;

Returns
Type Description
UserInfoOrBuilder

hasExportToCdwPipelineMetadata()

public boolean hasExportToCdwPipelineMetadata()

The pipeline metadata for Export-to-CDW pipeline.

.google.cloud.contentwarehouse.v1.RunPipelineMetadata.ExportToCdwPipelineMetadata export_to_cdw_pipeline_metadata = 6;

Returns
Type Description
boolean

Whether the exportToCdwPipelineMetadata field is set.

hasGcsIngestPipelineMetadata()

public boolean hasGcsIngestPipelineMetadata()

The pipeline metadata for GcsIngest pipeline.

.google.cloud.contentwarehouse.v1.RunPipelineMetadata.GcsIngestPipelineMetadata gcs_ingest_pipeline_metadata = 4;

Returns
Type Description
boolean

Whether the gcsIngestPipelineMetadata field is set.

hasProcessWithDocAiPipelineMetadata()

public boolean hasProcessWithDocAiPipelineMetadata()

The pipeline metadata for Process-with-DocAi pipeline.

.google.cloud.contentwarehouse.v1.RunPipelineMetadata.ProcessWithDocAiPipelineMetadata process_with_doc_ai_pipeline_metadata = 7;

Returns
Type Description
boolean

Whether the processWithDocAiPipelineMetadata field is set.

hasUserInfo()

public boolean hasUserInfo()

User unique identification and groups information.

.google.cloud.contentwarehouse.v1.UserInfo user_info = 3;

Returns
Type Description
boolean

Whether the userInfo field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RunPipelineMetadata.Builder newBuilderForType()
Returns
Type Description
RunPipelineMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunPipelineMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RunPipelineMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RunPipelineMetadata.Builder toBuilder()
Returns
Type Description
RunPipelineMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException