Represents an Execution.
Package
@google-cloud/workflowsConstructors
(constructor)(properties)
constructor(properties?: google.cloud.workflows.executions.v1.IExecution);
Constructs a new Execution.
Parameter | |
---|---|
Name | Description |
properties |
IExecution
Properties to set |
Properties
argument
public argument: string;
Execution argument.
callLogLevel
public callLogLevel: (google.cloud.workflows.executions.v1.Execution.CallLogLevel|keyof typeof google.cloud.workflows.executions.v1.Execution.CallLogLevel);
Execution callLogLevel.
duration
public duration?: (google.protobuf.IDuration|null);
Execution duration.
endTime
public endTime?: (google.protobuf.ITimestamp|null);
Execution endTime.
error
public error?: (google.cloud.workflows.executions.v1.Execution.IError|null);
Execution error.
labels
public labels: { [k: string]: string };
Execution labels.
name
public name: string;
Execution name.
result
public result: string;
Execution result.
startTime
public startTime?: (google.protobuf.ITimestamp|null);
Execution startTime.
state
public state: (google.cloud.workflows.executions.v1.Execution.State|keyof typeof google.cloud.workflows.executions.v1.Execution.State);
Execution state.
stateError
public stateError?: (google.cloud.workflows.executions.v1.Execution.IStateError|null);
Execution stateError.
status
public status?: (google.cloud.workflows.executions.v1.Execution.IStatus|null);
Execution status.
workflowRevisionId
public workflowRevisionId: string;
Execution workflowRevisionId.
Methods
create(properties)
public static create(properties?: google.cloud.workflows.executions.v1.IExecution): google.cloud.workflows.executions.v1.Execution;
Creates a new Execution instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IExecution
Properties to set |
Returns | |
---|---|
Type | Description |
Execution | Execution instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.workflows.executions.v1.Execution;
Decodes an Execution 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 |
Execution | Execution |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.workflows.executions.v1.Execution;
Decodes an Execution message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Execution | Execution |
encode(message, writer)
public static encode(message: google.cloud.workflows.executions.v1.IExecution, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Execution message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IExecution
Execution 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.workflows.executions.v1.IExecution, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Execution message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IExecution
Execution 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.workflows.executions.v1.Execution;
Creates an Execution 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 |
Execution | Execution |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Execution
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 Execution to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.workflows.executions.v1.Execution, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an Execution message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Execution
Execution |
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 an Execution message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|