Class RunJobRequest.Builder (2.23.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RunJobRequest build()
Returns
TypeDescription
RunJobRequest

buildPartial()

public RunJobRequest buildPartial()
Returns
TypeDescription
RunJobRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

public RunJobRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
RunJobRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getDefaultInstanceForType()

public RunJobRequest getDefaultInstanceForType()
Returns
TypeDescription
RunJobRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RunJobRequest other)

public RunJobRequest.Builder mergeFrom(RunJobRequest other)
Parameter
NameDescription
otherRunJobRequest
Returns
TypeDescription
RunJobRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

public RunJobRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueboolean

The legacyAppEngineCron to set.

Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RunJobRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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