Documentation

Google_Service_CloudMachineLearningEngine_Resource_ProjectsModels extends Google_Service_Resource
in package

The "models" collection of methods.

Typical usage is: $mlService = new Google_Service_CloudMachineLearningEngine(...); $models = $mlService->models;

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.
create()  : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Model
Creates a model which will later contain one or more versions. You must add at least one version before you can request predictions from the model. Add versions by calling projects.models.versions.create. (models.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation
Deletes a model. You can only delete a model if there are no versions in it.
get()  : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Model
Gets information about a model, including its name, the description (if set), and the default version (if at least one version of the model has been deployed). (models.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. (models.getIamPolicy)
listProjectsModels()  : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1ListModelsResponse
Lists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the request parameters, the list request returns an empty response body: {}.
patch()  : Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation
Updates a specific model resource. Currently the only supported fields to update are `description` and `default_version.name`. (models.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. (models.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 —

create()

Creates a model which will later contain one or more versions. You must add at least one version before you can request predictions from the model. Add versions by calling projects.models.versions.create. (models.create)

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

Required. The project name.

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

Optional parameters.

Return values
Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Model —

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

delete()

Deletes a model. You can only delete a model if there are no versions in it.

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation

You can delete versions by calling projects.models.versions.delete. (models.delete)

Parameters
$name : string

Required. The name of the model.

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

Optional parameters.

Return values
Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation —

get()

Gets information about a model, including its name, the description (if set), and the default version (if at least one version of the model has been deployed). (models.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Model
Parameters
$name : string

Required. The name of the model.

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

Optional parameters.

Return values
Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Model —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (models.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 —

listProjectsModels()

Lists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the request parameters, the list request returns an empty response body: {}.

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

(models.listProjectsModels)

Parameters
$parent : string

Required. The name of the project whose models are to be listed.

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

Optional parameters.

Tags
opt_param

int pageSize Optional. The number of models 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 models 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_CloudMachineLearningEngine_GoogleCloudMlV1ListModelsResponse —

patch()

Updates a specific model resource. Currently the only supported fields to update are `description` and `default_version.name`. (models.patch)

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

Required. The project name.

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

Optional parameters.

Tags
opt_param

string updateMask Required. Specifies the path, relative to Model, of the field to update. For example, to change the description of a model to "foo" and set its default version to "version_1", the update_mask parameter would be specified as description, default_version.name, and the PATCH request body would specify the new value, as follows: { "description": "foo", "defaultVersion": { "name":"version_1" } } Currently the supported update masks are description and default_version.name.

Return values
Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (models.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. (models.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