Google Cloud Dms V1 Client - Class SearchBackgroundJobsRequest (1.5.5)

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
Name
Description
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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$this

getReturnMostRecentPerJobType

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

Returns
Type
Description
bool

setReturnMostRecentPerJobType

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

Parameter
Name
Description
var
bool
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
int
Returns
Type
Description
$this

getCompletedUntilTime

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

Returns
Type
Description

hasCompletedUntilTime

clearCompletedUntilTime

setCompletedUntilTime

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

Parameter
Name
Description
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: