Class: Google::Cloud::Workflows::V1beta::Workflow

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

Overview

Workflow program to be executed by Workflows.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

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

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/workflows/v1beta/workflows.rb', line 80

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

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

  # Describes the current state of workflow deployment. More states may be
  # added in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1
  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.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/workflows/v1beta/workflows.rb', line 80

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

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

  # Describes the current state of workflow deployment. More states may be
  # added in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1
  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.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/workflows/v1beta/workflows.rb', line 80

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

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

  # Describes the current state of workflow deployment. More states may be
  # added in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1
  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}



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/workflows/v1beta/workflows.rb', line 80

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

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

  # Describes the current state of workflow deployment. More states may be
  # added in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

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

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

Returns Output only. The timestamp that the latest revision of the workflow was created.

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/workflows/v1beta/workflows.rb', line 80

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

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

  # Describes the current state of workflow deployment. More states may be
  # added in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The workflow has been deployed successfully and is serving.
    ACTIVE = 1
  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 fields of a workflow:

  • source_code
  • service_account The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 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 fields of a workflow:

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


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/workflows/v1beta/workflows.rb', line 80

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

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

  # Describes the current state of workflow deployment. More states may be
  # added in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

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

#service_account ⇒ ::String

Returns Name of 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}

Using - as a wildcard for the {project} 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) —

    Name of 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}

    Using - as a wildcard for the {project} 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.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/workflows/v1beta/workflows.rb', line 80

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

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

  # Describes the current state of workflow deployment. More states may be
  # added in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

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

#source_contents ⇒ ::String

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

Returns:

  • (::String) —

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/workflows/v1beta/workflows.rb', line 80

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

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

  # Describes the current state of workflow deployment. More states may be
  # added in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

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

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

Returns Output only. State of the workflow deployment.

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/workflows/v1beta/workflows.rb', line 80

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

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

  # Describes the current state of workflow deployment. More states may be
  # added in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

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

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

Returns Output only. The last update timestamp of the workflow.

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/workflows/v1beta/workflows.rb', line 80

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

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

  # Describes the current state of workflow deployment. More states may be
  # added in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

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