Google Cloud Dms V1 Client - Class SearchBackgroundJobsRequest (1.3.0)

Reference documentation and code samples for the Google Cloud Dms V1 Client class SearchBackgroundJobsRequest.

Request message for 'SearchBackgroundJobs' request.

Generated from protobuf message google.cloud.clouddms.v1.SearchBackgroundJobsRequest

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ conversion_workspace string

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

↳ return_most_recent_per_job_type bool

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

↳ max_size int

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.

↳ completed_until_time Google\Protobuf\Timestamp

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

getConversionWorkspace

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

Returns
TypeDescription
string

setConversionWorkspace

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReturnMostRecentPerJobType

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

Returns
TypeDescription
bool

setReturnMostRecentPerJobType

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

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.

Returns
TypeDescription
int

setMaxSize

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCompletedUntilTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCompletedUntilTime

clearCompletedUntilTime

setCompletedUntilTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this