Reference documentation and code samples for the Google Cloud Dms V1 Client class SearchBackgroundJobsRequest.
Request message for 'SearchBackgroundJobs' request.
Generated from protobuf messagegoogle.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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dms V1 Client - Class SearchBackgroundJobsRequest (2.0.6)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.6 (latest)](/php/docs/reference/cloud-dms/latest/V1.SearchBackgroundJobsRequest)\n- [2.0.5](/php/docs/reference/cloud-dms/2.0.5/V1.SearchBackgroundJobsRequest)\n- [1.5.5](/php/docs/reference/cloud-dms/1.5.5/V1.SearchBackgroundJobsRequest)\n- [1.4.2](/php/docs/reference/cloud-dms/1.4.2/V1.SearchBackgroundJobsRequest)\n- [1.3.0](/php/docs/reference/cloud-dms/1.3.0/V1.SearchBackgroundJobsRequest)\n- [1.2.1](/php/docs/reference/cloud-dms/1.2.1/V1.SearchBackgroundJobsRequest)\n- [1.1.0](/php/docs/reference/cloud-dms/1.1.0/V1.SearchBackgroundJobsRequest)\n- [1.0.5](/php/docs/reference/cloud-dms/1.0.5/V1.SearchBackgroundJobsRequest) \nReference documentation and code samples for the Google Cloud Dms V1 Client class SearchBackgroundJobsRequest.\n\nRequest message for 'SearchBackgroundJobs' request.\n\nGenerated from protobuf message `google.cloud.clouddms.v1.SearchBackgroundJobsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ CloudDms \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getConversionWorkspace\n\nRequired. Name of the conversion workspace resource whose jobs are listed,\nin the form of:\nprojects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.\n\n### setConversionWorkspace\n\nRequired. Name of the conversion workspace resource whose jobs are listed,\nin the form of:\nprojects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.\n\n### getReturnMostRecentPerJobType\n\nOptional. Whether or not to return just the most recent job per job type,\n\n### setReturnMostRecentPerJobType\n\nOptional. Whether or not to return just the most recent job per job type,\n\n### getMaxSize\n\nOptional. The maximum number of jobs to return. The service may return\nfewer than this value. If unspecified, at most 100 jobs are\nreturned. The maximum value is 100; values above 100 are coerced to\n100.\n\n### setMaxSize\n\nOptional. The maximum number of jobs to return. The service may return\nfewer than this value. If unspecified, at most 100 jobs are\nreturned. The maximum value is 100; values above 100 are coerced to\n100.\n\n### getCompletedUntilTime\n\nOptional. If provided, only returns jobs that completed until (not\nincluding) the given timestamp.\n\n### hasCompletedUntilTime\n\n### clearCompletedUntilTime\n\n### setCompletedUntilTime\n\nOptional. If provided, only returns jobs that completed until (not\nincluding) the given timestamp."]]
