Class SearchBackgroundJobsRequest (2.44.0) 

public final class SearchBackgroundJobsRequest extends GeneratedMessageV3 implements SearchBackgroundJobsRequestOrBuilder

Request message for 'SearchBackgroundJobs' request.

Protobuf type google.cloud.clouddms.v1.SearchBackgroundJobsRequest

Inheritance

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

Static Fields

COMPLETED_UNTIL_TIME_FIELD_NUMBER

public static final int COMPLETED_UNTIL_TIME_FIELD_NUMBER
Field Value
Type Description
int

CONVERSION_WORKSPACE_FIELD_NUMBER

public static final int CONVERSION_WORKSPACE_FIELD_NUMBER
Field Value
Type Description
int

MAX_SIZE_FIELD_NUMBER

public static final int MAX_SIZE_FIELD_NUMBER
Field Value
Type Description
int

RETURN_MOST_RECENT_PER_JOB_TYPE_FIELD_NUMBER

public static final int RETURN_MOST_RECENT_PER_JOB_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchBackgroundJobsRequest getDefaultInstance()
Returns
Type Description
SearchBackgroundJobsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(SearchBackgroundJobsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

getParserForType()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 SearchBackgroundJobsRequest.Builder newBuilderForType()
Returns
Type Description
SearchBackgroundJobsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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