Package com.google.cloud.dataproc.v1

Class WorkflowMetadata

  • All Implemented Interfaces:
    WorkflowMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class WorkflowMetadata
extends com.google.protobuf.GeneratedMessageV3
implements WorkflowMetadataOrBuilder
     A Dataproc workflow template resource.
    Protobuf type google.cloud.dataproc.v1.WorkflowMetadata
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getTemplate

        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];
        Specified by:
        getTemplate in interface WorkflowMetadataOrBuilder
        Returns:
        The template.

      • getTemplateBytes

        public com.google.protobuf.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];
        Specified by:
        getTemplateBytes in interface WorkflowMetadataOrBuilder
        Returns:
        The bytes for template.

      • getVersion

        public int getVersion()
         Output only. The version of template at the time of
 workflow instantiation.
        int32 version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVersion in interface WorkflowMetadataOrBuilder
        Returns:
        The version.

      • hasCreateCluster

        public boolean hasCreateCluster()
         Output only. The create cluster operation metadata.
        .google.cloud.dataproc.v1.ClusterOperation create_cluster = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateCluster in interface WorkflowMetadataOrBuilder
        Returns:
        Whether the createCluster field is set.

      • getCreateCluster

        public ClusterOperation getCreateCluster()
         Output only. The create cluster operation metadata.
        .google.cloud.dataproc.v1.ClusterOperation create_cluster = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateCluster in interface WorkflowMetadataOrBuilder
        Returns:
        The createCluster.

      • hasGraph

        public boolean hasGraph()
         Output only. The workflow graph.
        .google.cloud.dataproc.v1.WorkflowGraph graph = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasGraph in interface WorkflowMetadataOrBuilder
        Returns:
        Whether the graph field is set.

      • getGraph

        public WorkflowGraph getGraph()
         Output only. The workflow graph.
        .google.cloud.dataproc.v1.WorkflowGraph graph = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getGraph in interface WorkflowMetadataOrBuilder
        Returns:
        The graph.

      • hasDeleteCluster

        public boolean hasDeleteCluster()
         Output only. The delete cluster operation metadata.
        .google.cloud.dataproc.v1.ClusterOperation delete_cluster = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDeleteCluster in interface WorkflowMetadataOrBuilder
        Returns:
        Whether the deleteCluster field is set.

      • getDeleteCluster

        public ClusterOperation getDeleteCluster()
         Output only. The delete cluster operation metadata.
        .google.cloud.dataproc.v1.ClusterOperation delete_cluster = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeleteCluster in interface WorkflowMetadataOrBuilder
        Returns:
        The deleteCluster.

      • getStateValue

        public int getStateValue()
         Output only. The workflow state.
        .google.cloud.dataproc.v1.WorkflowMetadata.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface WorkflowMetadataOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public WorkflowMetadata.State getState()
         Output only. The workflow state.
        .google.cloud.dataproc.v1.WorkflowMetadata.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface WorkflowMetadataOrBuilder
        Returns:
        The state.

      • getClusterName

        public String getClusterName()
         Output only. The name of the target cluster.
        string cluster_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getClusterName in interface WorkflowMetadataOrBuilder
        Returns:
        The clusterName.

      • getClusterNameBytes

        public com.google.protobuf.ByteString getClusterNameBytes()
         Output only. The name of the target cluster.
        string cluster_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getClusterNameBytes in interface WorkflowMetadataOrBuilder
        Returns:
        The bytes for clusterName.

      • containsParameters

        public boolean containsParameters​(String key)
         Map from parameter names to values that were used for those parameters.
        map<string, string> parameters = 8;
        Specified by:
        containsParameters in interface WorkflowMetadataOrBuilder

      • hasStartTime

        public boolean hasStartTime()
         Output only. Workflow start time.
        .google.protobuf.Timestamp start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasStartTime in interface WorkflowMetadataOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Output only. Workflow start time.
        .google.protobuf.Timestamp start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTime in interface WorkflowMetadataOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. Workflow start time.
        .google.protobuf.Timestamp start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTimeOrBuilder in interface WorkflowMetadataOrBuilder

      • hasEndTime

        public boolean hasEndTime()
         Output only. Workflow end time.
        .google.protobuf.Timestamp end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasEndTime in interface WorkflowMetadataOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public com.google.protobuf.Timestamp getEndTime()
         Output only. Workflow end time.
        .google.protobuf.Timestamp end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTime in interface WorkflowMetadataOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         Output only. Workflow end time.
        .google.protobuf.Timestamp end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTimeOrBuilder in interface WorkflowMetadataOrBuilder

      • getClusterUuid

        public String getClusterUuid()
         Output only. The UUID of target cluster.
        string cluster_uuid = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getClusterUuid in interface WorkflowMetadataOrBuilder
        Returns:
        The clusterUuid.

      • getClusterUuidBytes

        public com.google.protobuf.ByteString getClusterUuidBytes()
         Output only. The UUID of target cluster.
        string cluster_uuid = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getClusterUuidBytes in interface WorkflowMetadataOrBuilder
        Returns:
        The bytes for clusterUuid.

      • hasDagTimeout

        public boolean hasDagTimeout()
         Output only. The timeout duration for the DAG of jobs, expressed in seconds
 (see [JSON representation of
 duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
        .google.protobuf.Duration dag_timeout = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDagTimeout in interface WorkflowMetadataOrBuilder
        Returns:
        Whether the dagTimeout field is set.

      • getDagTimeout

        public com.google.protobuf.Duration getDagTimeout()
         Output only. The timeout duration for the DAG of jobs, expressed in seconds
 (see [JSON representation of
 duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
        .google.protobuf.Duration dag_timeout = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDagTimeout in interface WorkflowMetadataOrBuilder
        Returns:
        The dagTimeout.

      • getDagTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getDagTimeoutOrBuilder()
         Output only. The timeout duration for the DAG of jobs, expressed in seconds
 (see [JSON representation of
 duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
        .google.protobuf.Duration dag_timeout = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDagTimeoutOrBuilder in interface WorkflowMetadataOrBuilder

      • hasDagStartTime

        public boolean hasDagStartTime()
         Output only. DAG start time, only set for workflows with
 [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
 DAG begins.
        .google.protobuf.Timestamp dag_start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDagStartTime in interface WorkflowMetadataOrBuilder
        Returns:
        Whether the dagStartTime field is set.

      • getDagStartTime

        public com.google.protobuf.Timestamp getDagStartTime()
         Output only. DAG start time, only set for workflows with
 [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
 DAG begins.
        .google.protobuf.Timestamp dag_start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDagStartTime in interface WorkflowMetadataOrBuilder
        Returns:
        The dagStartTime.

      • getDagStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getDagStartTimeOrBuilder()
         Output only. DAG start time, only set for workflows with
 [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
 DAG begins.
        .google.protobuf.Timestamp dag_start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDagStartTimeOrBuilder in interface WorkflowMetadataOrBuilder

      • hasDagEndTime

        public boolean hasDagEndTime()
         Output only. DAG end time, only set for workflows with
 [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
 DAG ends.
        .google.protobuf.Timestamp dag_end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDagEndTime in interface WorkflowMetadataOrBuilder
        Returns:
        Whether the dagEndTime field is set.

      • getDagEndTime

        public com.google.protobuf.Timestamp getDagEndTime()
         Output only. DAG end time, only set for workflows with
 [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
 DAG ends.
        .google.protobuf.Timestamp dag_end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDagEndTime in interface WorkflowMetadataOrBuilder
        Returns:
        The dagEndTime.

      • getDagEndTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getDagEndTimeOrBuilder()
         Output only. DAG end time, only set for workflows with
 [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
 DAG ends.
        .google.protobuf.Timestamp dag_end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDagEndTimeOrBuilder in interface WorkflowMetadataOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static WorkflowMetadata parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WorkflowMetadata parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WorkflowMetadata parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WorkflowMetadata parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WorkflowMetadata parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WorkflowMetadata parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WorkflowMetadata parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public WorkflowMetadata.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public WorkflowMetadata.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected WorkflowMetadata.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<WorkflowMetadata> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public WorkflowMetadata getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder