Represents a RunPipelineRequest.
Package
@google-cloud/contentwarehouseConstructors
(constructor)(properties)
constructor(properties?: google.cloud.contentwarehouse.v1.IRunPipelineRequest);
Constructs a new RunPipelineRequest.
Parameter | |
---|---|
Name | Description |
properties |
IRunPipelineRequest
Properties to set |
Properties
exportCdwPipeline
public exportCdwPipeline?: (google.cloud.contentwarehouse.v1.IExportToCdwPipeline|null);
RunPipelineRequest exportCdwPipeline.
gcsIngestPipeline
public gcsIngestPipeline?: (google.cloud.contentwarehouse.v1.IGcsIngestPipeline|null);
RunPipelineRequest gcsIngestPipeline.
gcsIngestWithDocAiProcessorsPipeline
public gcsIngestWithDocAiProcessorsPipeline?: (google.cloud.contentwarehouse.v1.IGcsIngestWithDocAiProcessorsPipeline|null);
RunPipelineRequest gcsIngestWithDocAiProcessorsPipeline.
name
public name: string;
RunPipelineRequest name.
pipeline
public pipeline?: ("gcsIngestPipeline"|"gcsIngestWithDocAiProcessorsPipeline"|"exportCdwPipeline"|"processWithDocAiPipeline");
RunPipelineRequest pipeline.
processWithDocAiPipeline
public processWithDocAiPipeline?: (google.cloud.contentwarehouse.v1.IProcessWithDocAiPipeline|null);
RunPipelineRequest processWithDocAiPipeline.
requestMetadata
public requestMetadata?: (google.cloud.contentwarehouse.v1.IRequestMetadata|null);
RunPipelineRequest requestMetadata.
Methods
create(properties)
public static create(properties?: google.cloud.contentwarehouse.v1.IRunPipelineRequest): google.cloud.contentwarehouse.v1.RunPipelineRequest;
Creates a new RunPipelineRequest instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IRunPipelineRequest
Properties to set |
Returns | |
---|---|
Type | Description |
RunPipelineRequest | RunPipelineRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contentwarehouse.v1.RunPipelineRequest;
Decodes a RunPipelineRequest message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
RunPipelineRequest | RunPipelineRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.RunPipelineRequest;
Decodes a RunPipelineRequest message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
RunPipelineRequest | RunPipelineRequest |
encode(message, writer)
public static encode(message: google.cloud.contentwarehouse.v1.IRunPipelineRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified RunPipelineRequest message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IRunPipelineRequest
RunPipelineRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.contentwarehouse.v1.IRunPipelineRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified RunPipelineRequest message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IRunPipelineRequest
RunPipelineRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.contentwarehouse.v1.RunPipelineRequest;
Creates a RunPipelineRequest message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
RunPipelineRequest | RunPipelineRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for RunPipelineRequest
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this RunPipelineRequest to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.contentwarehouse.v1.RunPipelineRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a RunPipelineRequest message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
RunPipelineRequest
RunPipelineRequest |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a RunPipelineRequest message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|