Class RunJobRequest.Builder (2.48.0)

public static final class RunJobRequest.Builder extends GeneratedMessageV3.Builder<RunJobRequest.Builder> implements RunJobRequestOrBuilder

Request message for forcing a job to run now using RunJob.

Protobuf type google.cloud.scheduler.v1beta1.RunJobRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunJobRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunJobRequest.Builder
Overrides

build()

public RunJobRequest build()
Returns
Type Description
RunJobRequest

buildPartial()

public RunJobRequest buildPartial()
Returns
Type Description
RunJobRequest

clear()

public RunJobRequest.Builder clear()
Returns
Type Description
RunJobRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RunJobRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RunJobRequest.Builder
Overrides

clearLegacyAppEngineCron()

public RunJobRequest.Builder clearLegacyAppEngineCron()

This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job in the __cron queue with the corresponding name will be forced to run instead.

bool legacy_app_engine_cron = 2;

Returns
Type Description
RunJobRequest.Builder

This builder for chaining.

clearName()

public RunJobRequest.Builder clearName()

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
RunJobRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RunJobRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RunJobRequest.Builder
Overrides

clone()

public RunJobRequest.Builder clone()
Returns
Type Description
RunJobRequest.Builder
Overrides

getDefaultInstanceForType()

public RunJobRequest getDefaultInstanceForType()
Returns
Type Description
RunJobRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLegacyAppEngineCron()

public boolean getLegacyAppEngineCron()

This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job in the __cron queue with the corresponding name will be forced to run instead.

bool legacy_app_engine_cron = 2;

Returns
Type Description
boolean

The legacyAppEngineCron.

getName()

public String getName()

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_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 job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RunJobRequest other)

public RunJobRequest.Builder mergeFrom(RunJobRequest other)
Parameter
Name Description
other RunJobRequest
Returns
Type Description
RunJobRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunJobRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunJobRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RunJobRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RunJobRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunJobRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunJobRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RunJobRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunJobRequest.Builder
Overrides

setLegacyAppEngineCron(boolean value)

public RunJobRequest.Builder setLegacyAppEngineCron(boolean value)

This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job in the __cron queue with the corresponding name will be forced to run instead.

bool legacy_app_engine_cron = 2;

Parameter
Name Description
value boolean

The legacyAppEngineCron to set.

Returns
Type Description
RunJobRequest.Builder

This builder for chaining.

setName(String value)

public RunJobRequest.Builder setName(String value)

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_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
RunJobRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RunJobRequest.Builder setNameBytes(ByteString value)

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_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
RunJobRequest.Builder

This builder for chaining.

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

public RunJobRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RunJobRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RunJobRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunJobRequest.Builder
Overrides