Class GetTaskRequest.Builder (2.41.0)

public static final class GetTaskRequest.Builder extends GeneratedMessageV3.Builder<GetTaskRequest.Builder> implements GetTaskRequestOrBuilder

Request message for getting a task using GetTask.

Protobuf type google.cloud.tasks.v2.GetTaskRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GetTaskRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
GetTaskRequest.Builder
Overrides

build()

public GetTaskRequest build()
Returns
TypeDescription
GetTaskRequest

buildPartial()

public GetTaskRequest buildPartial()
Returns
TypeDescription
GetTaskRequest

clear()

public GetTaskRequest.Builder clear()
Returns
TypeDescription
GetTaskRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public GetTaskRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
GetTaskRequest.Builder
Overrides

clearName()

public GetTaskRequest.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
TypeDescription
GetTaskRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GetTaskRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
GetTaskRequest.Builder
Overrides

clearResponseView()

public GetTaskRequest.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
TypeDescription
GetTaskRequest.Builder

This builder for chaining.

clone()

public GetTaskRequest.Builder clone()
Returns
TypeDescription
GetTaskRequest.Builder
Overrides

getDefaultInstanceForType()

public GetTaskRequest getDefaultInstanceForType()
Returns
TypeDescription
GetTaskRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for responseView.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(GetTaskRequest other)

public GetTaskRequest.Builder mergeFrom(GetTaskRequest other)
Parameter
NameDescription
otherGetTaskRequest
Returns
TypeDescription
GetTaskRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GetTaskRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GetTaskRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public GetTaskRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
GetTaskRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GetTaskRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
GetTaskRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public GetTaskRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
GetTaskRequest.Builder
Overrides

setName(String value)

public GetTaskRequest.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
NameDescription
valueString

The name to set.

Returns
TypeDescription
GetTaskRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GetTaskRequest.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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
GetTaskRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GetTaskRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
GetTaskRequest.Builder
Overrides

setResponseView(Task.View value)

public GetTaskRequest.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
NameDescription
valueTask.View

The responseView to set.

Returns
TypeDescription
GetTaskRequest.Builder

This builder for chaining.

setResponseViewValue(int value)

public GetTaskRequest.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
NameDescription
valueint

The enum numeric value on the wire for responseView to set.

Returns
TypeDescription
GetTaskRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final GetTaskRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
GetTaskRequest.Builder
Overrides