Class: Google::Cloud::Workflows::V1::Workflow

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

Overview

Workflow program to be executed by Workflows.

Defined Under Namespace

Modules: CallLogLevel, State Classes: LabelsEntry, StateError, UserEnvVarsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#call_log_level ⇒ ::Google::Cloud::Workflows::V1::Workflow::CallLogLevel

Returns Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.

Returns:

  • (::Google::Cloud::Workflows::V1::Workflow::CallLogLevel) —

    Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

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

Returns Output only. The timestamp for when the workflow was created.

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

#crypto_key_name ⇒ ::String

Returns Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow.

Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}

Using - as a wildcard for the {project} or not providing one at all will infer the project from the account.

If not provided, data associated with the workflow will not be CMEK-encrypted.

Returns:

  • (::String) —

    Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow.

    Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}

    Using - as a wildcard for the {project} or not providing one at all will infer the project from the account.

    If not provided, data associated with the workflow will not be CMEK-encrypted.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

#description ⇒ ::String

Returns Description of the workflow provided by the user. Must be at most 1000 unicode characters long.

Returns:

  • (::String) —

    Description of the workflow provided by the user. Must be at most 1000 unicode characters long.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

#name ⇒ ::String

Returns The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}.

Returns:

  • (::String) —

    The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

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

Returns Output only. The timestamp for the latest revision of the workflow's creation.

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

#revision_id ⇒ ::String (readonly)

Returns Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow:

  • Service account
  • [Workflow code to be executed][google.cloud.workflows.v1.Workflow.source_contents]

The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.

Returns:

  • (::String) —

    Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow:

    • Service account
    • [Workflow code to be executed][google.cloud.workflows.v1.Workflow.source_contents]

    The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

#service_account ⇒ ::String

Returns The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account}

Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. The {account} value can be the email address or the unique_id of the service account.

If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.

Returns:

  • (::String) —

    The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account}

    Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. The {account} value can be the email address or the unique_id of the service account.

    If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

#source_contents ⇒ ::String

Returns Workflow code to be executed. The size limit is 128KB.

Returns:

  • (::String) —

    Workflow code to be executed. The size limit is 128KB.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

#state ⇒ ::Google::Cloud::Workflows::V1::Workflow::State (readonly)

Returns Output only. State of the workflow deployment.

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

#state_error ⇒ ::Google::Cloud::Workflows::V1::Workflow::StateError (readonly)

Returns Output only. Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

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

Returns Output only. The timestamp for when the workflow was last updated.

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end

#user_env_vars ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS".

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS".



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 113

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

  # Describes an error related to the current state of the workflow.
  # @!attribute [rw] details
  #   @return [::String]
  #     Provides specifics about the error.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
  #     The type of this state error.
  class StateError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the possibled types of a state error.
    module Type
      # No type specified.
      TYPE_UNSPECIFIED = 0

      # Caused by an issue with KMS.
      KMS_ERROR = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserEnvVarsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of workflow deployment.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1

    # Workflow data is unavailable. See the `state_error` field.
    UNAVAILABLE = 2
  end

  # Describes the level of platform logging to apply to calls and call
  # responses during workflow executions.
  module CallLogLevel
    # No call logging level specified.
    CALL_LOG_LEVEL_UNSPECIFIED = 0

    # Log all call steps within workflows, all call returns, and all exceptions
    # raised.
    LOG_ALL_CALLS = 1

    # Log only exceptions that are raised from call steps within workflows.
    LOG_ERRORS_ONLY = 2

    # Explicitly log nothing.
    LOG_NONE = 3
  end
end