Class: Google::Cloud::Dataform::V1::WorkflowConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataform/v1/dataform.rb

Overview

Represents a Dataform workflow configuration.

Defined Under Namespace

Classes: ScheduledExecutionRecord

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp of when the WorkflowConfig was created.

Returns:



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
 
# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 2181

class WorkflowConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A record of an attempt to create a workflow invocation for this workflow
  # config.
  # @!attribute [rw] workflow_invocation
  #   @return [::String]
  #     The name of the created workflow invocation, if one was successfully
  #     created. Must be in the format
  #     `projects/*/locations/*/repositories/*/workflowInvocations/*`.
  #
  #     Note: The following fields are mutually exclusive: `workflow_invocation`, `error_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] error_status
  #   @return [::Google::Rpc::Status]
  #     The error status encountered upon this attempt to create the
  #     workflow invocation, if the attempt was unsuccessful.
  #
  #     Note: The following fields are mutually exclusive: `error_status`, `workflow_invocation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] execution_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The timestamp of this execution attempt.
  class ScheduledExecutionRecord
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#cron_schedule ⇒ ::String

Returns Optional. Optional schedule (in cron format) for automatic execution of this workflow config.

Returns:

  • (::String) —

    Optional. Optional schedule (in cron format) for automatic execution of this workflow config.



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
 
# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 2181

class WorkflowConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A record of an attempt to create a workflow invocation for this workflow
  # config.
  # @!attribute [rw] workflow_invocation
  #   @return [::String]
  #     The name of the created workflow invocation, if one was successfully
  #     created. Must be in the format
  #     `projects/*/locations/*/repositories/*/workflowInvocations/*`.
  #
  #     Note: The following fields are mutually exclusive: `workflow_invocation`, `error_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] error_status
  #   @return [::Google::Rpc::Status]
  #     The error status encountered upon this attempt to create the
  #     workflow invocation, if the attempt was unsuccessful.
  #
  #     Note: The following fields are mutually exclusive: `error_status`, `workflow_invocation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] execution_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The timestamp of this execution attempt.
  class ScheduledExecutionRecord
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#disabled ⇒ ::Boolean

Returns Optional. Disables automatic creation of workflow invocations.

Returns:

  • (::Boolean) —

    Optional. Disables automatic creation of workflow invocations.



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
 
# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 2181

class WorkflowConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A record of an attempt to create a workflow invocation for this workflow
  # config.
  # @!attribute [rw] workflow_invocation
  #   @return [::String]
  #     The name of the created workflow invocation, if one was successfully
  #     created. Must be in the format
  #     `projects/*/locations/*/repositories/*/workflowInvocations/*`.
  #
  #     Note: The following fields are mutually exclusive: `workflow_invocation`, `error_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] error_status
  #   @return [::Google::Rpc::Status]
  #     The error status encountered upon this attempt to create the
  #     workflow invocation, if the attempt was unsuccessful.
  #
  #     Note: The following fields are mutually exclusive: `error_status`, `workflow_invocation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] execution_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The timestamp of this execution attempt.
  class ScheduledExecutionRecord
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#internal_metadata ⇒ ::String (readonly)

Returns Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

Returns:

  • (::String) —

    Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
 
# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 2181

class WorkflowConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A record of an attempt to create a workflow invocation for this workflow
  # config.
  # @!attribute [rw] workflow_invocation
  #   @return [::String]
  #     The name of the created workflow invocation, if one was successfully
  #     created. Must be in the format
  #     `projects/*/locations/*/repositories/*/workflowInvocations/*`.
  #
  #     Note: The following fields are mutually exclusive: `workflow_invocation`, `error_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] error_status
  #   @return [::Google::Rpc::Status]
  #     The error status encountered upon this attempt to create the
  #     workflow invocation, if the attempt was unsuccessful.
  #
  #     Note: The following fields are mutually exclusive: `error_status`, `workflow_invocation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] execution_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The timestamp of this execution attempt.
  class ScheduledExecutionRecord
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#invocation_config ⇒ ::Google::Cloud::Dataform::V1::InvocationConfig

Returns Optional. If left unset, a default InvocationConfig will be used.

Returns:



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
 
# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 2181

class WorkflowConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A record of an attempt to create a workflow invocation for this workflow
  # config.
  # @!attribute [rw] workflow_invocation
  #   @return [::String]
  #     The name of the created workflow invocation, if one was successfully
  #     created. Must be in the format
  #     `projects/*/locations/*/repositories/*/workflowInvocations/*`.
  #
  #     Note: The following fields are mutually exclusive: `workflow_invocation`, `error_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] error_status
  #   @return [::Google::Rpc::Status]
  #     The error status encountered upon this attempt to create the
  #     workflow invocation, if the attempt was unsuccessful.
  #
  #     Note: The following fields are mutually exclusive: `error_status`, `workflow_invocation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] execution_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The timestamp of this execution attempt.
  class ScheduledExecutionRecord
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Identifier. The workflow config's name.

Returns:

  • (::String) —

    Identifier. The workflow config's name.



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
 
# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 2181

class WorkflowConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A record of an attempt to create a workflow invocation for this workflow
  # config.
  # @!attribute [rw] workflow_invocation
  #   @return [::String]
  #     The name of the created workflow invocation, if one was successfully
  #     created. Must be in the format
  #     `projects/*/locations/*/repositories/*/workflowInvocations/*`.
  #
  #     Note: The following fields are mutually exclusive: `workflow_invocation`, `error_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] error_status
  #   @return [::Google::Rpc::Status]
  #     The error status encountered upon this attempt to create the
  #     workflow invocation, if the attempt was unsuccessful.
  #
  #     Note: The following fields are mutually exclusive: `error_status`, `workflow_invocation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] execution_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The timestamp of this execution attempt.
  class ScheduledExecutionRecord
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#recent_scheduled_execution_records ⇒ ::Array<::Google::Cloud::Dataform::V1::WorkflowConfig::ScheduledExecutionRecord> (readonly)

Returns Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.

Returns:



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
 
# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 2181

class WorkflowConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A record of an attempt to create a workflow invocation for this workflow
  # config.
  # @!attribute [rw] workflow_invocation
  #   @return [::String]
  #     The name of the created workflow invocation, if one was successfully
  #     created. Must be in the format
  #     `projects/*/locations/*/repositories/*/workflowInvocations/*`.
  #
  #     Note: The following fields are mutually exclusive: `workflow_invocation`, `error_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] error_status
  #   @return [::Google::Rpc::Status]
  #     The error status encountered upon this attempt to create the
  #     workflow invocation, if the attempt was unsuccessful.
  #
  #     Note: The following fields are mutually exclusive: `error_status`, `workflow_invocation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] execution_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The timestamp of this execution attempt.
  class ScheduledExecutionRecord
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#release_config ⇒ ::String

Returns Required. The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.

Returns:

  • (::String) —

    Required. The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
 
# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 2181

class WorkflowConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A record of an attempt to create a workflow invocation for this workflow
  # config.
  # @!attribute [rw] workflow_invocation
  #   @return [::String]
  #     The name of the created workflow invocation, if one was successfully
  #     created. Must be in the format
  #     `projects/*/locations/*/repositories/*/workflowInvocations/*`.
  #
  #     Note: The following fields are mutually exclusive: `workflow_invocation`, `error_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] error_status
  #   @return [::Google::Rpc::Status]
  #     The error status encountered upon this attempt to create the
  #     workflow invocation, if the attempt was unsuccessful.
  #
  #     Note: The following fields are mutually exclusive: `error_status`, `workflow_invocation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] execution_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The timestamp of this execution attempt.
  class ScheduledExecutionRecord
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#time_zone ⇒ ::String

Returns Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database. If left unspecified, the default is UTC.

Returns:

  • (::String) —

    Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database. If left unspecified, the default is UTC.



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
 
# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 2181

class WorkflowConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A record of an attempt to create a workflow invocation for this workflow
  # config.
  # @!attribute [rw] workflow_invocation
  #   @return [::String]
  #     The name of the created workflow invocation, if one was successfully
  #     created. Must be in the format
  #     `projects/*/locations/*/repositories/*/workflowInvocations/*`.
  #
  #     Note: The following fields are mutually exclusive: `workflow_invocation`, `error_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] error_status
  #   @return [::Google::Rpc::Status]
  #     The error status encountered upon this attempt to create the
  #     workflow invocation, if the attempt was unsuccessful.
  #
  #     Note: The following fields are mutually exclusive: `error_status`, `workflow_invocation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] execution_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The timestamp of this execution attempt.
  class ScheduledExecutionRecord
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp of when the WorkflowConfig was last updated.

Returns:



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
 
# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 2181

class WorkflowConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A record of an attempt to create a workflow invocation for this workflow
  # config.
  # @!attribute [rw] workflow_invocation
  #   @return [::String]
  #     The name of the created workflow invocation, if one was successfully
  #     created. Must be in the format
  #     `projects/*/locations/*/repositories/*/workflowInvocations/*`.
  #
  #     Note: The following fields are mutually exclusive: `workflow_invocation`, `error_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] error_status
  #   @return [::Google::Rpc::Status]
  #     The error status encountered upon this attempt to create the
  #     workflow invocation, if the attempt was unsuccessful.
  #
  #     Note: The following fields are mutually exclusive: `error_status`, `workflow_invocation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] execution_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The timestamp of this execution attempt.
  class ScheduledExecutionRecord
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end