com.google.cloud.tasks.v2

Class RunTaskRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<RunTaskRequest.Builder>

com.google.cloud.tasks.v2.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.GeneratedMessageV3.Builder<RunTaskRequest.Builder>
implements RunTaskRequestOrBuilder

 Request message for forcing a task to run now using
 [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask].
 

Protobuf type google.cloud.tasks.v2.RunTaskRequest

Method Summary

Modifier and Type	Method and Description
RunTaskRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RunTaskRequest	build()
RunTaskRequest	buildPartial()
RunTaskRequest.Builder	clear()
RunTaskRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RunTaskRequest.Builder	clearName() Required.
RunTaskRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RunTaskRequest.Builder	clearResponseView() The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.
RunTaskRequest.Builder	clone()
RunTaskRequest	getDefaultInstanceForType()
static 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.v2.Task] will be returned.
int	getResponseViewValue() The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RunTaskRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RunTaskRequest.Builder	mergeFrom(com.google.protobuf.Message other)
RunTaskRequest.Builder	mergeFrom(RunTaskRequest other)
RunTaskRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RunTaskRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RunTaskRequest.Builder	setName(String value) Required.
RunTaskRequest.Builder	setNameBytes(com.google.protobuf.ByteString value) Required.
RunTaskRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RunTaskRequest.Builder	setResponseView(Task.View value) The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.
RunTaskRequest.Builder	setResponseViewValue(int value) The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.
RunTaskRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

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

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

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

addAll, addAll, 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.MessageOrBuilder

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

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

mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

clone

public RunTaskRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RunTaskRequest.Builder>

setField

public RunTaskRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RunTaskRequest.Builder>

clearField

public RunTaskRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RunTaskRequest.Builder>

clearOneof

public RunTaskRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RunTaskRequest.Builder>

setRepeatedField

public RunTaskRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunTaskRequest.Builder>

addRepeatedField

public RunTaskRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunTaskRequest.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.GeneratedMessageV3.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.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;

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.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;

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.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;

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.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;

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.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:

This builder for chaining.

setUnknownFields

public final RunTaskRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunTaskRequest.Builder>

mergeUnknownFields

public final RunTaskRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunTaskRequest.Builder>