Represents a WorkflowMetadata.
Package
@google-cloud/dataprocConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dataproc.v1.IWorkflowMetadata);Constructs a new WorkflowMetadata.
| Parameter | |
|---|---|
| Name | Description |
properties |
IWorkflowMetadata
Properties to set |
Properties
clusterName
public clusterName: string;WorkflowMetadata clusterName.
clusterUuid
public clusterUuid: string;WorkflowMetadata clusterUuid.
createCluster
public createCluster?: (google.cloud.dataproc.v1.IClusterOperation|null);WorkflowMetadata createCluster.
dagEndTime
public dagEndTime?: (google.protobuf.ITimestamp|null);WorkflowMetadata dagEndTime.
dagStartTime
public dagStartTime?: (google.protobuf.ITimestamp|null);WorkflowMetadata dagStartTime.
dagTimeout
public dagTimeout?: (google.protobuf.IDuration|null);WorkflowMetadata dagTimeout.
deleteCluster
public deleteCluster?: (google.cloud.dataproc.v1.IClusterOperation|null);WorkflowMetadata deleteCluster.
endTime
public endTime?: (google.protobuf.ITimestamp|null);WorkflowMetadata endTime.
graph
public graph?: (google.cloud.dataproc.v1.IWorkflowGraph|null);WorkflowMetadata graph.
parameters
public parameters: { [k: string]: string };WorkflowMetadata parameters.
startTime
public startTime?: (google.protobuf.ITimestamp|null);WorkflowMetadata startTime.
state
public state: (google.cloud.dataproc.v1.WorkflowMetadata.State|keyof typeof google.cloud.dataproc.v1.WorkflowMetadata.State);WorkflowMetadata state.
template
public template: string;WorkflowMetadata template.
version
public version: number;WorkflowMetadata version.
Methods
create(properties)
public static create(properties?: google.cloud.dataproc.v1.IWorkflowMetadata): google.cloud.dataproc.v1.WorkflowMetadata;Creates a new WorkflowMetadata instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IWorkflowMetadata
Properties to set |
| Returns | |
|---|---|
| Type | Description |
WorkflowMetadata |
WorkflowMetadata instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataproc.v1.WorkflowMetadata;Decodes a WorkflowMetadata 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 |
WorkflowMetadata |
WorkflowMetadata |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataproc.v1.WorkflowMetadata;Decodes a WorkflowMetadata message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
WorkflowMetadata |
WorkflowMetadata |
encode(message, writer)
public static encode(message: google.cloud.dataproc.v1.IWorkflowMetadata, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified WorkflowMetadata message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IWorkflowMetadata
WorkflowMetadata 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.dataproc.v1.IWorkflowMetadata, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified WorkflowMetadata message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IWorkflowMetadata
WorkflowMetadata 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.dataproc.v1.WorkflowMetadata;Creates a WorkflowMetadata 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 |
WorkflowMetadata |
WorkflowMetadata |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for WorkflowMetadata
| 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 WorkflowMetadata to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dataproc.v1.WorkflowMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a WorkflowMetadata message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
WorkflowMetadata
WorkflowMetadata |
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 WorkflowMetadata message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|