Documentation

Google_Service_CloudMachineLearning_Resource_ProjectsJobs extends Google_Service_Resource
in package

The "jobs" collection of methods.

Typical usage is: $mlService = new Google_Service_CloudMachineLearning(...); $jobs = $mlService->jobs;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
cancel()  : Google_Service_CloudMachineLearning_GoogleProtobufEmpty
Cancels a running job. (jobs.cancel)
create()  : Google_Service_CloudMachineLearning_GoogleCloudMlV1beta1Job
Creates a training or a batch prediction job. (jobs.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_CloudMachineLearning_GoogleCloudMlV1beta1Job
Describes a job. (jobs.get)
listProjectsJobs()  : Google_Service_CloudMachineLearning_GoogleCloudMlV1beta1ListJobsResponse
Lists the jobs in the project. (jobs.listProjectsJobs)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

cancel()

Cancels a running job. (jobs.cancel)

public cancel(string $name, Google_Service_CloudMachineLearning_GoogleCloudMlV1beta1CancelJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearning_GoogleProtobufEmpty
Parameters
$name : string

Required. The name of the job to cancel.

Authorization: requires Editor role on the parent project.

$postBody : Google_Service_CloudMachineLearning_GoogleCloudMlV1beta1CancelJobRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudMachineLearning_GoogleProtobufEmpty —

create()

Creates a training or a batch prediction job. (jobs.create)

public create(string $parent, Google_Service_CloudMachineLearning_GoogleCloudMlV1beta1Job $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearning_GoogleCloudMlV1beta1Job
Parameters
$parent : string

Required. The project name.

Authorization: requires Editor role on the specified project.

$postBody : Google_Service_CloudMachineLearning_GoogleCloudMlV1beta1Job
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudMachineLearning_GoogleCloudMlV1beta1Job —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

listProjectsJobs()

Lists the jobs in the project. (jobs.listProjectsJobs)

public listProjectsJobs(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearning_GoogleCloudMlV1beta1ListJobsResponse
Parameters
$parent : string

Required. The name of the project for which to list jobs.

Authorization: requires Viewer role on the specified project.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize Optional. The number of jobs to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the next_page_token field.

The default value is 20, and the maximum page size is 100.

opt_param

string filter Optional. Specifies the subset of jobs to retrieve.

opt_param

string pageToken Optional. A page token to request the next page of results.

You get the token from the next_page_token field of the response from the previous call.

Return values
Google_Service_CloudMachineLearning_GoogleCloudMlV1beta1ListJobsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results