Documentation

Google_Service_CloudMachineLearningEngine_Resource_ProjectsJobs extends Google_Service_Resource
in package

The "jobs" collection of methods.

Typical usage is: $mlService = new Google_Service_CloudMachineLearningEngine(...); $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_CloudMachineLearningEngine_GoogleProtobufEmpty
Cancels a running job. (jobs.cancel)
create()  : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Job
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_CloudMachineLearningEngine_GoogleCloudMlV1Job
Describes a job. (jobs.get)
getIamPolicy()  : Google_Service_CloudMachineLearningEngine_GoogleIamV1Policy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (jobs.getIamPolicy)
listProjectsJobs()  : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1ListJobsResponse
Lists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}.
patch()  : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Job
Updates a specific job resource. Currently the only supported fields to update are `labels`. (jobs.patch)
setIamPolicy()  : Google_Service_CloudMachineLearningEngine_GoogleIamV1Policy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (jobs.setIamPolicy)
testIamPermissions()  : Google_Service_CloudMachineLearningEngine_GoogleIamV1TestIamPermissionsResponse
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.
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_CloudMachineLearningEngine_GoogleCloudMlV1CancelJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleProtobufEmpty
Parameters
$name : string

Required. The name of the job to cancel.

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

Optional parameters.

Return values
Google_Service_CloudMachineLearningEngine_GoogleProtobufEmpty —

create()

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

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

Required. The project name.

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

Optional parameters.

Return values
Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Job —

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

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (jobs.getIamPolicy)

public getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleIamV1Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

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

Optional parameters.

Tags
opt_param

int options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- policies).

Return values
Google_Service_CloudMachineLearningEngine_GoogleIamV1Policy —

listProjectsJobs()

Lists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}.

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

(jobs.listProjectsJobs)

Parameters
$parent : string

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

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

Optional parameters.

Tags
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.

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. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census': gcloud ai-platform jobs list --filter='jobId:census*' List all failed jobs with names that start with 'rnn': gcloud ai-platform jobs list --filter='jobId:rnn* AND state:FAILED' For more examples, see the guide to monitoring jobs.

Return values
Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1ListJobsResponse —

patch()

Updates a specific job resource. Currently the only supported fields to update are `labels`. (jobs.patch)

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

Required. The job name.

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

Optional parameters.

Tags
opt_param

string updateMask Required. Specifies the path, relative to Job, of the field to update. To adopt etag mechanism, include etag field in the mask, and include the etag value in your job resource. For example, to change the labels of a job, the update_mask parameter would be specified as labels, etag, and the PATCH request body would specify the new value, as follows: { "labels": { "owner": "Google", "color": "Blue" } "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4" } If etag matches the one on the server, the labels of the job will be replaced with the given ones, and the server end etag will be recalculated. Currently the only supported update masks are labels and etag.

Return values
Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Job —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (jobs.setIamPolicy)

public setIamPolicy(string $resource, Google_Service_CloudMachineLearningEngine_GoogleIamV1SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleIamV1Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

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

Optional parameters.

Return values
Google_Service_CloudMachineLearningEngine_GoogleIamV1Policy —

testIamPermissions()

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

public testIamPermissions(string $resource, Google_Service_CloudMachineLearningEngine_GoogleIamV1TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleIamV1TestIamPermissionsResponse

This operation may "fail open" without warning. (jobs.testIamPermissions)

Parameters
$resource : string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

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

Optional parameters.

Return values
Google_Service_CloudMachineLearningEngine_GoogleIamV1TestIamPermissionsResponse —

convertToArrayAndStripNulls()

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

Search results