Documentation

Google_Service_RecommendationsAI_Resource_ProjectsLocationsCatalogsEventStoresOperations extends Google_Service_Resource
in package

The "operations" collection of methods.

Typical usage is: $recommendationengineService = new Google_Service_RecommendationsAI(...); $operations = $recommendationengineService->operations;

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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_RecommendationsAI_GoogleLongrunningOperation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. (operations.get)
listProjectsLocationsCatalogsEventStoresOperations()  : Google_Service_RecommendationsAI_GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. (operations.listProjectsLocationsCatalogsEventStoresOperations)
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

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

get()

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. (operations.get)

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

The name of the operation resource.

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

Optional parameters.

Return values
Google_Service_RecommendationsAI_GoogleLongrunningOperation

listProjectsLocationsCatalogsEventStoresOperations()

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. (operations.listProjectsLocationsCatalogsEventStoresOperations)

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

The name of the operation's parent resource.

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

Optional parameters.

Tags
opt_param

string filter The standard list filter.

opt_param

int pageSize The standard list page size.

opt_param

string pageToken The standard list page token.

Return values
Google_Service_RecommendationsAI_GoogleLongrunningListOperationsResponse

convertToArrayAndStripNulls()

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

Search results