public static final class RunTaskRequest.Builder extends GeneratedMessageV3.Builder<RunTaskRequest.Builder> implements RunTaskRequestOrBuilder
Request message for forcing a task to run now using
RunTask.
Protobuf type google.cloud.tasks.v2.RunTaskRequest
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RunTaskRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public RunTaskRequest build()
Returns
buildPartial()
public RunTaskRequest buildPartial()
Returns
clear()
public RunTaskRequest.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public RunTaskRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
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
clearOneof(Descriptors.OneofDescriptor oneof)
public RunTaskRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearResponseView()
public RunTaskRequest.Builder clearResponseView()
The response_view specifies which subset of the Task will be
returned.
By default response_view is 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 requires
cloudtasks.tasks.fullView
Google IAM
permission on the Task resource.
.google.cloud.tasks.v2.Task.View response_view = 2;
Returns
clone()
public RunTaskRequest.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public RunTaskRequest getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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
Type | Description |
String | The name.
|
getNameBytes()
public 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
getResponseView()
public Task.View getResponseView()
The response_view specifies which subset of the Task will be
returned.
By default response_view is 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 requires
cloudtasks.tasks.fullView
Google IAM
permission on the Task resource.
.google.cloud.tasks.v2.Task.View response_view = 2;
Returns
getResponseViewValue()
public int getResponseViewValue()
The response_view specifies which subset of the Task will be
returned.
By default response_view is 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 requires
cloudtasks.tasks.fullView
Google IAM
permission on the Task resource.
.google.cloud.tasks.v2.Task.View response_view = 2;
Returns
Type | Description |
int | The enum numeric value on the wire for responseView.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(RunTaskRequest other)
public RunTaskRequest.Builder mergeFrom(RunTaskRequest other)
Parameter
Returns
public RunTaskRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public RunTaskRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RunTaskRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public RunTaskRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setName(String value)
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) = { ... }
Parameter
Name | Description |
value | String
The name to set.
|
Returns
setNameBytes(ByteString value)
public RunTaskRequest.Builder setNameBytes(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) = { ... }
Parameter
Name | Description |
value | ByteString
The bytes for name to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RunTaskRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setResponseView(Task.View value)
public RunTaskRequest.Builder setResponseView(Task.View value)
The response_view specifies which subset of the Task will be
returned.
By default response_view is 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 requires
cloudtasks.tasks.fullView
Google IAM
permission on the Task resource.
.google.cloud.tasks.v2.Task.View response_view = 2;
Parameter
Name | Description |
value | Task.View
The responseView to set.
|
Returns
setResponseViewValue(int value)
public RunTaskRequest.Builder setResponseViewValue(int value)
The response_view specifies which subset of the Task will be
returned.
By default response_view is 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 requires
cloudtasks.tasks.fullView
Google IAM
permission on the Task resource.
.google.cloud.tasks.v2.Task.View response_view = 2;
Parameter
Name | Description |
value | int
The enum numeric value on the wire for responseView to set.
|
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final RunTaskRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides