Documentation

Google_Service_CloudMachineLearningEngine_Resource_ProjectsModelsVersions extends Google_Service_Resource
in package

The "versions" collection of methods.

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

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_GoogleLongrunningOperation
Creates a new version of a model from a trained TensorFlow model. If the version created in the cloud by this call is the first deployed version of the specified model, it will be made the default version of the model. When you add a version to a model that already has one or more versions, the default version does not automatically change. If you want a new version to be the default, you must call projects.models.versions.setDefault.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation
Deletes a model version. Each model can have multiple versions deployed and in use at any given time. Use this method to remove a single version. Note: You cannot delete the version that is set as the default version of the model unless it is the only remaining version. (versions.delete)
get()  : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Version
Gets information about a model version. Models can have multiple versions.
listProjectsModelsVersions()  : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1ListVersionsResponse
Gets basic information about all the versions of a model. If you expect that a model has many versions, or if you need to handle only a limited number of results at a time, you can request that the list be retrieved in batches (called pages). If there are no versions that match the request parameters, the list request returns an empty response body: {}.
patch()  : Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation
Updates the specified Version resource. Currently the only update-able fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. (versions.patch)
setDefault()  : Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Version
Designates a version to be the default for the model. The default version is used for prediction requests made against the model that don't specify a version. The first version to be created for a model is automatically set as the default. You must make any subsequent changes to the default version setting manually using this method. (versions.setDefault)
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 new version of a model from a trained TensorFlow model. If the version created in the cloud by this call is the first deployed version of the specified model, it will be made the default version of the model. When you add a version to a model that already has one or more versions, the default version does not automatically change. If you want a new version to be the default, you must call projects.models.versions.setDefault.

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

(versions.create)

Parameters
$parent : string

Required. The name of the model.

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

Optional parameters.

Return values
Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation

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 version. Each model can have multiple versions deployed and in use at any given time. Use this method to remove a single version. Note: You cannot delete the version that is set as the default version of the model unless it is the only remaining version. (versions.delete)

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

Required. The name of the version. You can get the names of all the versions of a model by calling projects.models.versions.list.

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

Optional parameters.

Return values
Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation

get()

Gets information about a model version. Models can have multiple versions.

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

You can call projects.models.versions.list to get the same information that this method returns for all of the versions of a model. (versions.get)

Parameters
$name : string

Required. The name of the version.

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

Optional parameters.

Return values
Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Version

listProjectsModelsVersions()

Gets basic information about all the versions of a model. If you expect that a model has many versions, or if you need to handle only a limited number of results at a time, you can request that the list be retrieved in batches (called pages). If there are no versions that match the request parameters, the list request returns an empty response body: {}.

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

(versions.listProjectsModelsVersions)

Parameters
$parent : string

Required. The name of the model for which to list the version.

$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

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

opt_param

int pageSize Optional. The number of versions 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.

Return values
Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1ListVersionsResponse

patch()

Updates the specified Version resource. Currently the only update-able fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. (versions.patch)

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

Required. The name of the model.

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

Optional parameters.

Tags
opt_param

string updateMask Required. Specifies the path, relative to Version, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the update_mask parameter would be specified as description, and the PATCH request body would specify the new value, as follows: { "description": "foo" } Currently the only supported update mask fields are description, requestLoggingConfig, autoScaling.minNodes, and manualScaling.nodes. However, you can only update manualScaling.nodes if the version uses a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online- prediction).

Return values
Google_Service_CloudMachineLearningEngine_GoogleLongrunningOperation

setDefault()

Designates a version to be the default for the model. The default version is used for prediction requests made against the model that don't specify a version. The first version to be created for a model is automatically set as the default. You must make any subsequent changes to the default version setting manually using this method. (versions.setDefault)

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

Required. The name of the version to make the default for the model. You can get the names of all the versions of a model by calling projects.models.versions.list.

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

Optional parameters.

Return values
Google_Service_CloudMachineLearningEngine_GoogleCloudMlV1Version

convertToArrayAndStripNulls()

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

Search results