Class SearchBackgroundJobsRequest.Builder (2.30.0)

Version 2.30.0

• 2.52.0 (latest)
• 2.51.0
• 2.50.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.8
• 2.1.9

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchBackgroundJobsRequest.Builder

Implements

SearchBackgroundJobsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchBackgroundJobsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchBackgroundJobsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchBackgroundJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchBackgroundJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)