Class RunTaskRequest (2.45.0)

public final class RunTaskRequest extends GeneratedMessageV3 implements RunTaskRequestOrBuilder

Request message for forcing a task to run now using RunTask.

Protobuf type google.cloud.tasks.v2beta3.RunTaskRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_VIEW_FIELD_NUMBER

public static final int RESPONSE_VIEW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RunTaskRequest getDefaultInstance()
Returns
Type Description
RunTaskRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RunTaskRequest.Builder newBuilder()
Returns
Type Description
RunTaskRequest.Builder

newBuilder(RunTaskRequest prototype)

public static RunTaskRequest.Builder newBuilder(RunTaskRequest prototype)
Parameter
Name Description
prototype RunTaskRequest
Returns
Type Description
RunTaskRequest.Builder

parseDelimitedFrom(InputStream input)

public static RunTaskRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunTaskRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunTaskRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunTaskRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RunTaskRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RunTaskRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunTaskRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunTaskRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunTaskRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RunTaskRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunTaskRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunTaskRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunTaskRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RunTaskRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunTaskRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunTaskRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RunTaskRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunTaskRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunTaskRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunTaskRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RunTaskRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RunTaskRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunTaskRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunTaskRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RunTaskRequest> parser()
Returns
Type Description
Parser<RunTaskRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public RunTaskRequest getDefaultInstanceForType()
Returns
Type Description
RunTaskRequest

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.

getParserForType()

public Parser<RunTaskRequest> getParserForType()
Returns
Type Description
Parser<RunTaskRequest>
Overrides

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.v2beta3.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.v2beta3.Task.View response_view = 2;

Returns
Type Description
int

The enum numeric value on the wire for responseView.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RunTaskRequest.Builder newBuilderForType()
Returns
Type Description
RunTaskRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunTaskRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RunTaskRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RunTaskRequest.Builder toBuilder()
Returns
Type Description
RunTaskRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException