Package com.google.cloud.tasks.v2beta2

Class RunTaskRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RunTaskRequest.Builder>
com.google.cloud.tasks.v2beta2.RunTaskRequest.Builder
All Implemented Interfaces:
RunTaskRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RunTaskRequest
public static final class RunTaskRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<RunTaskRequest.Builder> implements RunTaskRequestOrBuilder
 Request message for forcing a task to run now using
 [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask].
Protobuf type google.cloud.tasks.v2beta2.RunTaskRequest

  • Method Summary

    Modifier and Type
    Method
    Description
    RunTaskRequest
    build()
     
    RunTaskRequest
    buildPartial()
     
    RunTaskRequest.Builder
    clear()
     
    RunTaskRequest.Builder
    clearName()
    Required.
    RunTaskRequest.Builder
    clearResponseView()
    The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
    RunTaskRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    Task.View
    getResponseView()
    The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
    int
    getResponseViewValue()
    The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    RunTaskRequest.Builder
    mergeFrom(RunTaskRequest other)
     
    RunTaskRequest.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    RunTaskRequest.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    RunTaskRequest.Builder
    setName(String value)
    Required.
    RunTaskRequest.Builder
    setNameBytes(com.google.protobuf.ByteString value)
    Required.
    RunTaskRequest.Builder
    setResponseView(Task.View value)
    The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
    RunTaskRequest.Builder
    setResponseViewValue(int value)
    The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RunTaskRequest.Builder>

    • clear

      public RunTaskRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<RunTaskRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<RunTaskRequest.Builder>

    • getDefaultInstanceForType

      public RunTaskRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public RunTaskRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public RunTaskRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public RunTaskRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunTaskRequest.Builder>

    • mergeFrom

      public RunTaskRequest.Builder mergeFrom(RunTaskRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RunTaskRequest.Builder>

    • mergeFrom

      public RunTaskRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunTaskRequest.Builder>
      Throws:
      IOException

    • getName

      public 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) = { ... }
      Specified by:
      getName in interface RunTaskRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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) = { ... }
      Specified by:
      getNameBytes in interface RunTaskRequestOrBuilder
      Returns:
      The bytes for name.

    • setName

      public RunTaskRequest.Builder setName(String value)
       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) = { ... }
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public RunTaskRequest.Builder clearName()
       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:
      This builder for chaining.

    • setNameBytes

      public RunTaskRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getResponseViewValue

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

 By default response_view is
 [BASIC][google.cloud.tasks.v2beta2.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.v2beta2.Task.View.FULL]
 requires `cloudtasks.tasks.fullView` [Google
 IAM](https://cloud.google.com/iam/) permission on the
 [Task][google.cloud.tasks.v2beta2.Task] resource.
      .google.cloud.tasks.v2beta2.Task.View response_view = 2;
      Specified by:
      getResponseViewValue in interface RunTaskRequestOrBuilder
      Returns:
      The enum numeric value on the wire for responseView.

    • setResponseViewValue

      public RunTaskRequest.Builder setResponseViewValue(int value)
       The response_view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] will be returned.

 By default response_view is
 [BASIC][google.cloud.tasks.v2beta2.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.v2beta2.Task.View.FULL]
 requires `cloudtasks.tasks.fullView` [Google
 IAM](https://cloud.google.com/iam/) permission on the
 [Task][google.cloud.tasks.v2beta2.Task] resource.
      .google.cloud.tasks.v2beta2.Task.View response_view = 2;
      Parameters:
      value - The enum numeric value on the wire for responseView to set.
      Returns:
      This builder for chaining.

    • getResponseView

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

 By default response_view is
 [BASIC][google.cloud.tasks.v2beta2.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.v2beta2.Task.View.FULL]
 requires `cloudtasks.tasks.fullView` [Google
 IAM](https://cloud.google.com/iam/) permission on the
 [Task][google.cloud.tasks.v2beta2.Task] resource.
      .google.cloud.tasks.v2beta2.Task.View response_view = 2;
      Specified by:
      getResponseView in interface RunTaskRequestOrBuilder
      Returns:
      The responseView.

    • setResponseView

      public RunTaskRequest.Builder setResponseView(Task.View value)
       The response_view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] will be returned.

 By default response_view is
 [BASIC][google.cloud.tasks.v2beta2.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.v2beta2.Task.View.FULL]
 requires `cloudtasks.tasks.fullView` [Google
 IAM](https://cloud.google.com/iam/) permission on the
 [Task][google.cloud.tasks.v2beta2.Task] resource.
      .google.cloud.tasks.v2beta2.Task.View response_view = 2;
      Parameters:
      value - The responseView to set.
      Returns:
      This builder for chaining.

    • clearResponseView

      public RunTaskRequest.Builder clearResponseView()
       The response_view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] will be returned.

 By default response_view is
 [BASIC][google.cloud.tasks.v2beta2.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.v2beta2.Task.View.FULL]
 requires `cloudtasks.tasks.fullView` [Google
 IAM](https://cloud.google.com/iam/) permission on the
 [Task][google.cloud.tasks.v2beta2.Task] resource.
      .google.cloud.tasks.v2beta2.Task.View response_view = 2;
      Returns:
      This builder for chaining.