Class: Google::Cloud::Tasks::V2::Task

Inherits:

Object

• Object
• Google::Cloud::Tasks::V2::Task

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/tasks/v2/task.rb

Overview

A unit of scheduled work.

Defined Under Namespace

Modules: View

Instance Attribute Summary

• #app_engine_http_request ⇒ ::Google::Cloud::Tasks::V2::AppEngineHttpRequest

  HTTP request that is sent to the App Engine app handler.

• #create_time ⇒ ::Google::Protobuf::Timestamp

  Output only.

• #dispatch_count ⇒ ::Integer

  Output only.

• #dispatch_deadline ⇒ ::Google::Protobuf::Duration

  The deadline for requests sent to the worker.

• #first_attempt ⇒ ::Google::Cloud::Tasks::V2::Attempt

  Output only.

• #http_request ⇒ ::Google::Cloud::Tasks::V2::HttpRequest

  HTTP request that is sent to the worker.

• #last_attempt ⇒ ::Google::Cloud::Tasks::V2::Attempt

  Output only.

• #name ⇒ ::String

  Optionally caller-specified in CreateTask.

• #response_count ⇒ ::Integer

  Output only.

• #schedule_time ⇒ ::Google::Protobuf::Timestamp

  The time when the task is scheduled to be attempted or retried.

• #view ⇒ ::Google::Cloud::Tasks::V2::Task::View

  Output only.

Instance Attribute Details

#app_engine_http_request ⇒ ::Google::Cloud::Tasks::V2::AppEngineHttpRequest

# File 'proto_docs/google/cloud/tasks/v2/task.rb', line 122

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

  # The view specifies a subset of {::Google::Cloud::Tasks::V2::Task Task} data.
  #
  # When a task is returned in a response, not all
  # information is retrieved by default because some data, such as
  # payloads, might be desirable to return only when needed because
  # of its large size or because of the sensitivity of data that it
  # contains.
  module View
    # Unspecified. Defaults to BASIC.
    VIEW_UNSPECIFIED = 0

    # The basic view omits fields which can be large or can contain
    # sensitive data.
    #
    # This view does not include the
    # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
    # Bodies are desirable to return only when needed, because they
    # can be large and because of the sensitivity of the data that you
    # choose to store in it.
    BASIC = 1

    # All information is returned.
    #
    # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
    # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    # permission on the {::Google::Cloud::Tasks::V2::Queue Queue} resource.
    FULL = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp

# File 'proto_docs/google/cloud/tasks/v2/task.rb', line 122

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

  # The view specifies a subset of {::Google::Cloud::Tasks::V2::Task Task} data.
  #
  # When a task is returned in a response, not all
  # information is retrieved by default because some data, such as
  # payloads, might be desirable to return only when needed because
  # of its large size or because of the sensitivity of data that it
  # contains.
  module View
    # Unspecified. Defaults to BASIC.
    VIEW_UNSPECIFIED = 0

    # The basic view omits fields which can be large or can contain
    # sensitive data.
    #
    # This view does not include the
    # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
    # Bodies are desirable to return only when needed, because they
    # can be large and because of the sensitivity of the data that you
    # choose to store in it.
    BASIC = 1

    # All information is returned.
    #
    # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
    # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    # permission on the {::Google::Cloud::Tasks::V2::Queue Queue} resource.
    FULL = 2
  end
end

#dispatch_count ⇒ ::Integer

# File 'proto_docs/google/cloud/tasks/v2/task.rb', line 122

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

  # The view specifies a subset of {::Google::Cloud::Tasks::V2::Task Task} data.
  #
  # When a task is returned in a response, not all
  # information is retrieved by default because some data, such as
  # payloads, might be desirable to return only when needed because
  # of its large size or because of the sensitivity of data that it
  # contains.
  module View
    # Unspecified. Defaults to BASIC.
    VIEW_UNSPECIFIED = 0

    # The basic view omits fields which can be large or can contain
    # sensitive data.
    #
    # This view does not include the
    # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
    # Bodies are desirable to return only when needed, because they
    # can be large and because of the sensitivity of the data that you
    # choose to store in it.
    BASIC = 1

    # All information is returned.
    #
    # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
    # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    # permission on the {::Google::Cloud::Tasks::V2::Queue Queue} resource.
    FULL = 2
  end
end

#dispatch_deadline ⇒ ::Google::Protobuf::Duration

# File 'proto_docs/google/cloud/tasks/v2/task.rb', line 122

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

  # The view specifies a subset of {::Google::Cloud::Tasks::V2::Task Task} data.
  #
  # When a task is returned in a response, not all
  # information is retrieved by default because some data, such as
  # payloads, might be desirable to return only when needed because
  # of its large size or because of the sensitivity of data that it
  # contains.
  module View
    # Unspecified. Defaults to BASIC.
    VIEW_UNSPECIFIED = 0

    # The basic view omits fields which can be large or can contain
    # sensitive data.
    #
    # This view does not include the
    # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
    # Bodies are desirable to return only when needed, because they
    # can be large and because of the sensitivity of the data that you
    # choose to store in it.
    BASIC = 1

    # All information is returned.
    #
    # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
    # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    # permission on the {::Google::Cloud::Tasks::V2::Queue Queue} resource.
    FULL = 2
  end
end

#first_attempt ⇒ ::Google::Cloud::Tasks::V2::Attempt

# File 'proto_docs/google/cloud/tasks/v2/task.rb', line 122

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

  # The view specifies a subset of {::Google::Cloud::Tasks::V2::Task Task} data.
  #
  # When a task is returned in a response, not all
  # information is retrieved by default because some data, such as
  # payloads, might be desirable to return only when needed because
  # of its large size or because of the sensitivity of data that it
  # contains.
  module View
    # Unspecified. Defaults to BASIC.
    VIEW_UNSPECIFIED = 0

    # The basic view omits fields which can be large or can contain
    # sensitive data.
    #
    # This view does not include the
    # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
    # Bodies are desirable to return only when needed, because they
    # can be large and because of the sensitivity of the data that you
    # choose to store in it.
    BASIC = 1

    # All information is returned.
    #
    # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
    # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    # permission on the {::Google::Cloud::Tasks::V2::Queue Queue} resource.
    FULL = 2
  end
end

#http_request ⇒ ::Google::Cloud::Tasks::V2::HttpRequest

# File 'proto_docs/google/cloud/tasks/v2/task.rb', line 122

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

  # The view specifies a subset of {::Google::Cloud::Tasks::V2::Task Task} data.
  #
  # When a task is returned in a response, not all
  # information is retrieved by default because some data, such as
  # payloads, might be desirable to return only when needed because
  # of its large size or because of the sensitivity of data that it
  # contains.
  module View
    # Unspecified. Defaults to BASIC.
    VIEW_UNSPECIFIED = 0

    # The basic view omits fields which can be large or can contain
    # sensitive data.
    #
    # This view does not include the
    # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
    # Bodies are desirable to return only when needed, because they
    # can be large and because of the sensitivity of the data that you
    # choose to store in it.
    BASIC = 1

    # All information is returned.
    #
    # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
    # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    # permission on the {::Google::Cloud::Tasks::V2::Queue Queue} resource.
    FULL = 2
  end
end

#last_attempt ⇒ ::Google::Cloud::Tasks::V2::Attempt

# File 'proto_docs/google/cloud/tasks/v2/task.rb', line 122

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

  # The view specifies a subset of {::Google::Cloud::Tasks::V2::Task Task} data.
  #
  # When a task is returned in a response, not all
  # information is retrieved by default because some data, such as
  # payloads, might be desirable to return only when needed because
  # of its large size or because of the sensitivity of data that it
  # contains.
  module View
    # Unspecified. Defaults to BASIC.
    VIEW_UNSPECIFIED = 0

    # The basic view omits fields which can be large or can contain
    # sensitive data.
    #
    # This view does not include the
    # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
    # Bodies are desirable to return only when needed, because they
    # can be large and because of the sensitivity of the data that you
    # choose to store in it.
    BASIC = 1

    # All information is returned.
    #
    # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
    # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    # permission on the {::Google::Cloud::Tasks::V2::Queue Queue} resource.
    FULL = 2
  end
end

#name ⇒ ::String

# File 'proto_docs/google/cloud/tasks/v2/task.rb', line 122

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

  # The view specifies a subset of {::Google::Cloud::Tasks::V2::Task Task} data.
  #
  # When a task is returned in a response, not all
  # information is retrieved by default because some data, such as
  # payloads, might be desirable to return only when needed because
  # of its large size or because of the sensitivity of data that it
  # contains.
  module View
    # Unspecified. Defaults to BASIC.
    VIEW_UNSPECIFIED = 0

    # The basic view omits fields which can be large or can contain
    # sensitive data.
    #
    # This view does not include the
    # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
    # Bodies are desirable to return only when needed, because they
    # can be large and because of the sensitivity of the data that you
    # choose to store in it.
    BASIC = 1

    # All information is returned.
    #
    # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
    # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    # permission on the {::Google::Cloud::Tasks::V2::Queue Queue} resource.
    FULL = 2
  end
end

#response_count ⇒ ::Integer

# File 'proto_docs/google/cloud/tasks/v2/task.rb', line 122

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

  # The view specifies a subset of {::Google::Cloud::Tasks::V2::Task Task} data.
  #
  # When a task is returned in a response, not all
  # information is retrieved by default because some data, such as
  # payloads, might be desirable to return only when needed because
  # of its large size or because of the sensitivity of data that it
  # contains.
  module View
    # Unspecified. Defaults to BASIC.
    VIEW_UNSPECIFIED = 0

    # The basic view omits fields which can be large or can contain
    # sensitive data.
    #
    # This view does not include the
    # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
    # Bodies are desirable to return only when needed, because they
    # can be large and because of the sensitivity of the data that you
    # choose to store in it.
    BASIC = 1

    # All information is returned.
    #
    # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
    # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    # permission on the {::Google::Cloud::Tasks::V2::Queue Queue} resource.
    FULL = 2
  end
end

#schedule_time ⇒ ::Google::Protobuf::Timestamp

# File 'proto_docs/google/cloud/tasks/v2/task.rb', line 122

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

  # The view specifies a subset of {::Google::Cloud::Tasks::V2::Task Task} data.
  #
  # When a task is returned in a response, not all
  # information is retrieved by default because some data, such as
  # payloads, might be desirable to return only when needed because
  # of its large size or because of the sensitivity of data that it
  # contains.
  module View
    # Unspecified. Defaults to BASIC.
    VIEW_UNSPECIFIED = 0

    # The basic view omits fields which can be large or can contain
    # sensitive data.
    #
    # This view does not include the
    # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
    # Bodies are desirable to return only when needed, because they
    # can be large and because of the sensitivity of the data that you
    # choose to store in it.
    BASIC = 1

    # All information is returned.
    #
    # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
    # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    # permission on the {::Google::Cloud::Tasks::V2::Queue Queue} resource.
    FULL = 2
  end
end

#view ⇒ ::Google::Cloud::Tasks::V2::Task::View

# File 'proto_docs/google/cloud/tasks/v2/task.rb', line 122

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

  # The view specifies a subset of {::Google::Cloud::Tasks::V2::Task Task} data.
  #
  # When a task is returned in a response, not all
  # information is retrieved by default because some data, such as
  # payloads, might be desirable to return only when needed because
  # of its large size or because of the sensitivity of data that it
  # contains.
  module View
    # Unspecified. Defaults to BASIC.
    VIEW_UNSPECIFIED = 0

    # The basic view omits fields which can be large or can contain
    # sensitive data.
    #
    # This view does not include the
    # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
    # Bodies are desirable to return only when needed, because they
    # can be large and because of the sensitivity of the data that you
    # choose to store in it.
    BASIC = 1

    # All information is returned.
    #
    # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
    # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    # permission on the {::Google::Cloud::Tasks::V2::Queue Queue} resource.
    FULL = 2
  end
end