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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RunTaskRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public RunTaskRequest build()
buildPartial()
public RunTaskRequest buildPartial()
clear()
public RunTaskRequest.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public RunTaskRequest.Builder clearField(Descriptors.FieldDescriptor field)
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) = { ... }
clearOneof(Descriptors.OneofDescriptor oneof)
public RunTaskRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
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;
clone()
public RunTaskRequest.Builder clone()
Overrides
getDefaultInstanceForType()
public RunTaskRequest getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
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 |
---|
Type | Description |
ByteString | The bytes for name.
|
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 |
---|
Type | Description |
Task.View | The responseView.
|
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()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(RunTaskRequest other)
public RunTaskRequest.Builder mergeFrom(RunTaskRequest other)
public RunTaskRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public RunTaskRequest.Builder mergeFrom(Message other)
Parameter |
---|
Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RunTaskRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public RunTaskRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
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.
|
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.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RunTaskRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
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.
|
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.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final RunTaskRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides