Class SearchBackgroundJobsRequest.Builder (2.47.0)

public static final class SearchBackgroundJobsRequest.Builder extends GeneratedMessageV3.Builder<SearchBackgroundJobsRequest.Builder> implements SearchBackgroundJobsRequestOrBuilder

Request message for 'SearchBackgroundJobs' request.

Protobuf type google.cloud.clouddms.v1.SearchBackgroundJobsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SearchBackgroundJobsRequest build()
Returns
Type Description
SearchBackgroundJobsRequest

buildPartial()

public SearchBackgroundJobsRequest buildPartial()
Returns
Type Description
SearchBackgroundJobsRequest

clear()

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

clearCompletedUntilTime()

public SearchBackgroundJobsRequest.Builder clearCompletedUntilTime()

Optional. If provided, only returns jobs that completed until (not including) the given timestamp.

.google.protobuf.Timestamp completed_until_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchBackgroundJobsRequest.Builder

clearConversionWorkspace()

public SearchBackgroundJobsRequest.Builder clearConversionWorkspace()

Required. Name of the conversion workspace resource whose jobs are listed, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

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

Returns
Type Description
SearchBackgroundJobsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearMaxSize()

public SearchBackgroundJobsRequest.Builder clearMaxSize()

Optional. The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 100 jobs are returned. The maximum value is 100; values above 100 are coerced to 100.

int32 max_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchBackgroundJobsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearReturnMostRecentPerJobType()

public SearchBackgroundJobsRequest.Builder clearReturnMostRecentPerJobType()

Optional. Whether or not to return just the most recent job per job type,

bool return_most_recent_per_job_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchBackgroundJobsRequest.Builder

This builder for chaining.

clone()

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

getCompletedUntilTime()

public Timestamp getCompletedUntilTime()

Optional. If provided, only returns jobs that completed until (not including) the given timestamp.

.google.protobuf.Timestamp completed_until_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The completedUntilTime.

getCompletedUntilTimeBuilder()

public Timestamp.Builder getCompletedUntilTimeBuilder()

Optional. If provided, only returns jobs that completed until (not including) the given timestamp.

.google.protobuf.Timestamp completed_until_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getCompletedUntilTimeOrBuilder()

public TimestampOrBuilder getCompletedUntilTimeOrBuilder()

Optional. If provided, only returns jobs that completed until (not including) the given timestamp.

.google.protobuf.Timestamp completed_until_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getConversionWorkspace()

public String getConversionWorkspace()

Required. Name of the conversion workspace resource whose jobs are listed, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

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

Returns
Type Description
String

The conversionWorkspace.

getConversionWorkspaceBytes()

public ByteString getConversionWorkspaceBytes()

Required. Name of the conversion workspace resource whose jobs are listed, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

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

Returns
Type Description
ByteString

The bytes for conversionWorkspace.

getDefaultInstanceForType()

public SearchBackgroundJobsRequest getDefaultInstanceForType()
Returns
Type Description
SearchBackgroundJobsRequest

getDescriptorForType()

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

getMaxSize()

public int getMaxSize()

Optional. The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 100 jobs are returned. The maximum value is 100; values above 100 are coerced to 100.

int32 max_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The maxSize.

getReturnMostRecentPerJobType()

public boolean getReturnMostRecentPerJobType()

Optional. Whether or not to return just the most recent job per job type,

bool return_most_recent_per_job_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The returnMostRecentPerJobType.

hasCompletedUntilTime()

public boolean hasCompletedUntilTime()

Optional. If provided, only returns jobs that completed until (not including) the given timestamp.

.google.protobuf.Timestamp completed_until_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the completedUntilTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCompletedUntilTime(Timestamp value)

public SearchBackgroundJobsRequest.Builder mergeCompletedUntilTime(Timestamp value)

Optional. If provided, only returns jobs that completed until (not including) the given timestamp.

.google.protobuf.Timestamp completed_until_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Timestamp
Returns
Type Description
SearchBackgroundJobsRequest.Builder

mergeFrom(SearchBackgroundJobsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCompletedUntilTime(Timestamp value)

public SearchBackgroundJobsRequest.Builder setCompletedUntilTime(Timestamp value)

Optional. If provided, only returns jobs that completed until (not including) the given timestamp.

.google.protobuf.Timestamp completed_until_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Timestamp
Returns
Type Description
SearchBackgroundJobsRequest.Builder

setCompletedUntilTime(Timestamp.Builder builderForValue)

public SearchBackgroundJobsRequest.Builder setCompletedUntilTime(Timestamp.Builder builderForValue)

Optional. If provided, only returns jobs that completed until (not including) the given timestamp.

.google.protobuf.Timestamp completed_until_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SearchBackgroundJobsRequest.Builder

setConversionWorkspace(String value)

public SearchBackgroundJobsRequest.Builder setConversionWorkspace(String value)

Required. Name of the conversion workspace resource whose jobs are listed, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

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

Parameter
Name Description
value String

The conversionWorkspace to set.

Returns
Type Description
SearchBackgroundJobsRequest.Builder

This builder for chaining.

setConversionWorkspaceBytes(ByteString value)

public SearchBackgroundJobsRequest.Builder setConversionWorkspaceBytes(ByteString value)

Required. Name of the conversion workspace resource whose jobs are listed, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

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

Parameter
Name Description
value ByteString

The bytes for conversionWorkspace to set.

Returns
Type Description
SearchBackgroundJobsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setMaxSize(int value)

public SearchBackgroundJobsRequest.Builder setMaxSize(int value)

Optional. The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 100 jobs are returned. The maximum value is 100; values above 100 are coerced to 100.

int32 max_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The maxSize to set.

Returns
Type Description
SearchBackgroundJobsRequest.Builder

This builder for chaining.

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

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

setReturnMostRecentPerJobType(boolean value)

public SearchBackgroundJobsRequest.Builder setReturnMostRecentPerJobType(boolean value)

Optional. Whether or not to return just the most recent job per job type,

bool return_most_recent_per_job_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The returnMostRecentPerJobType to set.

Returns
Type Description
SearchBackgroundJobsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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