- 2.47.0 (latest)
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.12
- 2.2.0
- 2.1.11
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.v2beta2.RunTaskRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RunTaskRequest.BuilderImplements
RunTaskRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RunTaskRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder |
build()
public RunTaskRequest build()
Returns | |
---|---|
Type | Description |
RunTaskRequest |
buildPartial()
public RunTaskRequest buildPartial()
Returns | |
---|---|
Type | Description |
RunTaskRequest |
clear()
public RunTaskRequest.Builder clear()
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public RunTaskRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder |
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 | |
---|---|
Type | Description |
RunTaskRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public RunTaskRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder |
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.v2beta2.Task.View response_view = 2;
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder | This builder for chaining. |
clone()
public RunTaskRequest.Builder clone()
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder |
getDefaultInstanceForType()
public RunTaskRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
RunTaskRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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) = { ... }
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.v2beta2.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.v2beta2.Task.View response_view = 2;
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for responseView. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(RunTaskRequest other)
public RunTaskRequest.Builder mergeFrom(RunTaskRequest other)
Parameter | |
---|---|
Name | Description |
other | RunTaskRequest |
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RunTaskRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public RunTaskRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RunTaskRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public RunTaskRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder |
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 | |
---|---|
Type | Description |
RunTaskRequest.Builder | This builder for chaining. |
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 | |
---|---|
Type | Description |
RunTaskRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RunTaskRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder |
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.v2beta2.Task.View response_view = 2;
Parameter | |
---|---|
Name | Description |
value | Task.View The responseView to set. |
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder | This builder for chaining. |
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.v2beta2.Task.View response_view = 2;
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for responseView to set. |
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final RunTaskRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RunTaskRequest.Builder |