public final class WorkflowMetadata extends GeneratedMessageV3 implements WorkflowMetadataOrBuilder
A Dataproc workflow template resource.
Protobuf type google.cloud.dataproc.v1.WorkflowMetadata
Static Fields
public static final int CLUSTER_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int CLUSTER_UUID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int CREATE_CLUSTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DAG_END_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DAG_START_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DAG_TIMEOUT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DELETE_CLUSTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int END_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int GRAPH_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PARAMETERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int START_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int TEMPLATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int VERSION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static WorkflowMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static WorkflowMetadata.Builder newBuilder()
public static WorkflowMetadata.Builder newBuilder(WorkflowMetadata prototype)
public static WorkflowMetadata parseDelimitedFrom(InputStream input)
public static WorkflowMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkflowMetadata parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static WorkflowMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WorkflowMetadata parseFrom(ByteString data)
public static WorkflowMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkflowMetadata parseFrom(CodedInputStream input)
public static WorkflowMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkflowMetadata parseFrom(InputStream input)
public static WorkflowMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkflowMetadata parseFrom(ByteBuffer data)
public static WorkflowMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<WorkflowMetadata> parser()
Methods
public boolean containsParameters(String key)
Map from parameter names to values that were used for those parameters.
map<string, string> parameters = 8;
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public String getClusterName()
Output only. The name of the target cluster.
string cluster_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The clusterName.
|
public ByteString getClusterNameBytes()
Output only. The name of the target cluster.
string cluster_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for clusterName.
|
public String getClusterUuid()
Output only. The UUID of target cluster.
string cluster_uuid = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The clusterUuid.
|
public ByteString getClusterUuidBytes()
Output only. The UUID of target cluster.
string cluster_uuid = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for clusterUuid.
|
public ClusterOperation getCreateCluster()
Output only. The create cluster operation metadata.
.google.cloud.dataproc.v1.ClusterOperation create_cluster = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ClusterOperationOrBuilder getCreateClusterOrBuilder()
Output only. The create cluster operation metadata.
.google.cloud.dataproc.v1.ClusterOperation create_cluster = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Timestamp getDagEndTime()
Output only. DAG end time, only set for workflows with
dag_timeout when
DAG ends.
.google.protobuf.Timestamp dag_end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The dagEndTime.
|
public TimestampOrBuilder getDagEndTimeOrBuilder()
Output only. DAG end time, only set for workflows with
dag_timeout when
DAG ends.
.google.protobuf.Timestamp dag_end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Timestamp getDagStartTime()
Output only. DAG start time, only set for workflows with
dag_timeout when
DAG begins.
.google.protobuf.Timestamp dag_start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The dagStartTime.
|
public TimestampOrBuilder getDagStartTimeOrBuilder()
Output only. DAG start time, only set for workflows with
dag_timeout when
DAG begins.
.google.protobuf.Timestamp dag_start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Duration getDagTimeout()
Output only. The timeout duration for the DAG of jobs, expressed in seconds
(see JSON representation of
duration).
.google.protobuf.Duration dag_timeout = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Duration | The dagTimeout.
|
public DurationOrBuilder getDagTimeoutOrBuilder()
Output only. The timeout duration for the DAG of jobs, expressed in seconds
(see JSON representation of
duration).
.google.protobuf.Duration dag_timeout = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public WorkflowMetadata getDefaultInstanceForType()
public ClusterOperation getDeleteCluster()
Output only. The delete cluster operation metadata.
.google.cloud.dataproc.v1.ClusterOperation delete_cluster = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ClusterOperationOrBuilder getDeleteClusterOrBuilder()
Output only. The delete cluster operation metadata.
.google.cloud.dataproc.v1.ClusterOperation delete_cluster = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Timestamp getEndTime()
Output only. Workflow end time.
.google.protobuf.Timestamp end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getEndTimeOrBuilder()
Output only. Workflow end time.
.google.protobuf.Timestamp end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public WorkflowGraph getGraph()
Output only. The workflow graph.
.google.cloud.dataproc.v1.WorkflowGraph graph = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public WorkflowGraphOrBuilder getGraphOrBuilder()
Output only. The workflow graph.
.google.cloud.dataproc.v1.WorkflowGraph graph = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Map<String,String> getParameters()
public int getParametersCount()
Map from parameter names to values that were used for those parameters.
map<string, string> parameters = 8;
| Returns |
|---|
| Type | Description |
int | |
public Map<String,String> getParametersMap()
Map from parameter names to values that were used for those parameters.
map<string, string> parameters = 8;
public String getParametersOrDefault(String key, String defaultValue)
Map from parameter names to values that were used for those parameters.
map<string, string> parameters = 8;
public String getParametersOrThrow(String key)
Map from parameter names to values that were used for those parameters.
map<string, string> parameters = 8;
| Parameter |
|---|
| Name | Description |
key | String
|
public Parser<WorkflowMetadata> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public Timestamp getStartTime()
Output only. Workflow start time.
.google.protobuf.Timestamp start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The startTime.
|
public TimestampOrBuilder getStartTimeOrBuilder()
Output only. Workflow start time.
.google.protobuf.Timestamp start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public WorkflowMetadata.State getState()
Output only. The workflow state.
.google.cloud.dataproc.v1.WorkflowMetadata.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getStateValue()
Output only. The workflow state.
.google.cloud.dataproc.v1.WorkflowMetadata.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
public String getTemplate()
Output only. The resource name of the workflow template as described
in https://cloud.google.com/apis/design/resource_names.
- For
projects.regions.workflowTemplates, the resource name of the
template has the following format:
projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
- For
projects.locations.workflowTemplates, the resource name of the
template has the following format:
projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
string template = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The template.
|
public ByteString getTemplateBytes()
Output only. The resource name of the workflow template as described
in https://cloud.google.com/apis/design/resource_names.
- For
projects.regions.workflowTemplates, the resource name of the
template has the following format:
projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
- For
projects.locations.workflowTemplates, the resource name of the
template has the following format:
projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
string template = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for template.
|
public final UnknownFieldSet getUnknownFields()
Overrides
Output only. The version of template at the time of
workflow instantiation.
int32 version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The version.
|
public boolean hasCreateCluster()
Output only. The create cluster operation metadata.
.google.cloud.dataproc.v1.ClusterOperation create_cluster = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createCluster field is set.
|
public boolean hasDagEndTime()
Output only. DAG end time, only set for workflows with
dag_timeout when
DAG ends.
.google.protobuf.Timestamp dag_end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the dagEndTime field is set.
|
public boolean hasDagStartTime()
Output only. DAG start time, only set for workflows with
dag_timeout when
DAG begins.
.google.protobuf.Timestamp dag_start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the dagStartTime field is set.
|
public boolean hasDagTimeout()
Output only. The timeout duration for the DAG of jobs, expressed in seconds
(see JSON representation of
duration).
.google.protobuf.Duration dag_timeout = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the dagTimeout field is set.
|
public boolean hasDeleteCluster()
Output only. The delete cluster operation metadata.
.google.cloud.dataproc.v1.ClusterOperation delete_cluster = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the deleteCluster field is set.
|
public boolean hasEndTime()
Output only. Workflow end time.
.google.protobuf.Timestamp end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the endTime field is set.
|
public boolean hasGraph()
Output only. The workflow graph.
.google.cloud.dataproc.v1.WorkflowGraph graph = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the graph field is set.
|
public boolean hasStartTime()
Output only. Workflow start time.
.google.protobuf.Timestamp start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the startTime field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public WorkflowMetadata.Builder newBuilderForType()
protected WorkflowMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public WorkflowMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
