Package com.google.cloud.tasks.v2

Interface GetTaskRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    GetTaskRequest, GetTaskRequest.Builder
    public interface GetTaskRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getName()
      Required.
      com.google.protobuf.ByteString getNameBytes()
      Required.
      Task.View getResponseView()
      The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.
      int getResponseViewValue()
      The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getName

        String getName()
         Required. The task name. For example:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Required. The task name. For example:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for name.

      • getResponseViewValue

        int getResponseViewValue()
         The response_view specifies which subset of the
 [Task][google.cloud.tasks.v2.Task] will be returned.

 By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.BASIC];
 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.

 Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires
 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
 permission on the [Task][google.cloud.tasks.v2.Task] resource.
        .google.cloud.tasks.v2.Task.View response_view = 2;
        Returns:
        The enum numeric value on the wire for responseView.

      • getResponseView

        Task.View getResponseView()
         The response_view specifies which subset of the
 [Task][google.cloud.tasks.v2.Task] will be returned.

 By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.BASIC];
 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.

 Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires
 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
 permission on the [Task][google.cloud.tasks.v2.Task] resource.
        .google.cloud.tasks.v2.Task.View response_view = 2;
        Returns:
        The responseView.