gestione documentale avanzata 1 parte

This commit is contained in:
2026-05-28 09:34:28 +02:00
parent 3471befb1a
commit f2b0833b90
34482 changed files with 4312269 additions and 546 deletions
@@ -0,0 +1,33 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\APIManagement\Resource;
/**
* The "projects" collection of methods.
* Typical usage is:
* <code>
* $apimService = new Google\Service\APIManagement(...);
* $projects = $apimService->projects;
* </code>
*/
class Projects extends \Google\Service\Resource
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Projects::class, 'Google_Service_APIManagement_Resource_Projects');
@@ -0,0 +1,128 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\APIManagement\Resource;
use Google\Service\APIManagement\Entitlement;
use Google\Service\APIManagement\ListApiObservationTagsResponse;
use Google\Service\APIManagement\ListLocationsResponse;
use Google\Service\APIManagement\Location;
/**
* The "locations" collection of methods.
* Typical usage is:
* <code>
* $apimService = new Google\Service\APIManagement(...);
* $locations = $apimService->projects_locations;
* </code>
*/
class ProjectsLocations extends \Google\Service\Resource
{
/**
* Gets information about a location. (locations.get)
*
* @param string $name Resource name for the location.
* @param array $optParams Optional parameters.
* @return Location
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Location::class);
}
/**
* GetEntitlement returns the entitlement for the provided project.
* (locations.getEntitlement)
*
* @param string $name Required. The entitlement resource name Format:
* projects/{project}/locations/{location}/entitlement
* @param array $optParams Optional parameters.
* @return Entitlement
* @throws \Google\Service\Exception
*/
public function getEntitlement($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getEntitlement', [$params], Entitlement::class);
}
/**
* Lists information about the supported locations for this service. This method
* lists locations based on the resource scope provided in the
* ListLocationsRequest.name field: * **Global locations**: If `name` is empty,
* the method lists the public locations available to all projects. * **Project-
* specific locations**: If `name` follows the format `projects/{project}`, the
* method lists locations visible to that specific project. This includes
* public, private, or other project-specific locations enabled for the project.
* For gRPC and client library implementations, the resource name is passed as
* the `name` field. For direct service calls, the resource name is incorporated
* into the request path based on the specific service implementation and
* version. (locations.listProjectsLocations)
*
* @param string $name The resource that owns the locations collection, if
* applicable.
* @param array $optParams Optional parameters.
*
* @opt_param string extraLocationTypes Optional. Do not use this field unless
* explicitly documented otherwise. This is primarily for internal usage.
* @opt_param string filter A filter to narrow down results to a preferred
* subset. The filtering language accepts strings like `"displayName=tokyo"`,
* and is documented in more detail in [AIP-160](https://google.aip.dev/160).
* @opt_param int pageSize The maximum number of results to return. If not set,
* the service selects a default.
* @opt_param string pageToken A page token received from the `next_page_token`
* field in the response. Send that page token to receive the subsequent page.
* @return ListLocationsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocations($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListLocationsResponse::class);
}
/**
* ListApiObservationTags lists all extant tags on any observation in the given
* project. (locations.listApiObservationTags)
*
* @param string $parent Required. The parent, which owns this collection of
* tags. Format: projects/{project}/locations/{location}
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Optional. The maximum number of tags to return. The
* service may return fewer than this value. If unspecified, at most 10 tags
* will be returned. The maximum value is 1000; values above 1000 will be
* coerced to 1000.
* @opt_param string pageToken Optional. A page token, received from a previous
* `ListApiObservationTags` call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListApiObservationTags`
* must match the call that provided the page token.
* @return ListApiObservationTagsResponse
* @throws \Google\Service\Exception
*/
public function listApiObservationTags($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('listApiObservationTags', [$params], ListApiObservationTagsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocations::class, 'Google_Service_APIManagement_Resource_ProjectsLocations');
@@ -0,0 +1,162 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\APIManagement\Resource;
use Google\Service\APIManagement\DisableObservationJobRequest;
use Google\Service\APIManagement\EnableObservationJobRequest;
use Google\Service\APIManagement\ListObservationJobsResponse;
use Google\Service\APIManagement\ObservationJob;
use Google\Service\APIManagement\Operation;
/**
* The "observationJobs" collection of methods.
* Typical usage is:
* <code>
* $apimService = new Google\Service\APIManagement(...);
* $observationJobs = $apimService->projects_locations_observationJobs;
* </code>
*/
class ProjectsLocationsObservationJobs extends \Google\Service\Resource
{
/**
* CreateObservationJob creates a new ObservationJob but does not have any
* effecton its own. It is a configuration that can be used in an Observation
* Job to collect data about existing APIs. (observationJobs.create)
*
* @param string $parent Required. The parent resource where this ObservationJob
* will be created. Format: projects/{project}/locations/{location}
* @param ObservationJob $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string observationJobId Required. The ID to use for the
* Observation Job. This value should be 4-63 characters, and valid characters
* are /a-z-/.
* @opt_param string requestId Optional. An optional request ID to identify
* requests. Specify a unique request ID so that if you must retry your request,
* the server will know to ignore the request if it has already been completed.
* The server will guarantee that for at least 60 minutes since the first
* request. For example, consider a situation where you make an initial request
* and the request times out. If you make the request again with the same
* request ID, the server can check if original operation with the same request
* ID was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments. The request ID must
* be a valid UUID with the exception that zero UUID is not supported
* (00000000-0000-0000-0000-000000000000).
* @return Operation
* @throws \Google\Service\Exception
*/
public function create($parent, ObservationJob $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* DeleteObservationJob deletes an ObservationJob. This method will fail if the
* observation job is currently being used by any ObservationSource, even if not
* enabled. (observationJobs.delete)
*
* @param string $name Required. Name of the resource Format:
* projects/{project}/locations/{location}/observationJobs/{observation_job}
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Disables the given ObservationJob. (observationJobs.disable)
*
* @param string $name Required. The name of the ObservationJob to disable.
* Format: projects/{project}/locations/{location}/observationJobs/{job}
* @param DisableObservationJobRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function disable($name, DisableObservationJobRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('disable', [$params], Operation::class);
}
/**
* Enables the given ObservationJob. (observationJobs.enable)
*
* @param string $name Required. The name of the ObservationJob to enable.
* Format: projects/{project}/locations/{location}/observationJobs/{job}
* @param EnableObservationJobRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function enable($name, EnableObservationJobRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('enable', [$params], Operation::class);
}
/**
* GetObservationJob retrieves a single ObservationJob by name.
* (observationJobs.get)
*
* @param string $name Required. The name of the ObservationJob to retrieve.
* Format: projects/{project}/locations/{location}/observationJobs/{job}
* @param array $optParams Optional parameters.
* @return ObservationJob
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ObservationJob::class);
}
/**
* ListObservationJobs gets all ObservationJobs for a given project and
* location. (observationJobs.listProjectsLocationsObservationJobs)
*
* @param string $parent Required. The parent, which owns this collection of
* ObservationJobs. Format: projects/{project}/locations/{location}
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Optional. The maximum number of ObservationJobs to
* return. The service may return fewer than this value. If unspecified, at most
* 10 ObservationJobs will be returned. The maximum value is 1000; values above
* 1000 will be coerced to 1000.
* @opt_param string pageToken Optional. A page token, received from a previous
* `ListObservationJobs` call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListObservationJobs` must
* match the call that provided the page token.
* @return ListObservationJobsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsObservationJobs($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListObservationJobsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsObservationJobs::class, 'Google_Service_APIManagement_Resource_ProjectsLocationsObservationJobs');
@@ -0,0 +1,100 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\APIManagement\Resource;
use Google\Service\APIManagement\ApiObservation;
use Google\Service\APIManagement\BatchEditTagsApiObservationsRequest;
use Google\Service\APIManagement\BatchEditTagsApiObservationsResponse;
use Google\Service\APIManagement\ListApiObservationsResponse;
/**
* The "apiObservations" collection of methods.
* Typical usage is:
* <code>
* $apimService = new Google\Service\APIManagement(...);
* $apiObservations = $apimService->projects_locations_observationJobs_apiObservations;
* </code>
*/
class ProjectsLocationsObservationJobsApiObservations extends \Google\Service\Resource
{
/**
* BatchEditTagsApiObservations adds or removes Tags for ApiObservations.
* (apiObservations.batchEditTags)
*
* @param string $parent Required. The parent resource shared by all
* ApiObservations being edited. Format:
* projects/{project}/locations/{location}/observationJobs/{observation_job}
* @param BatchEditTagsApiObservationsRequest $postBody
* @param array $optParams Optional parameters.
* @return BatchEditTagsApiObservationsResponse
* @throws \Google\Service\Exception
*/
public function batchEditTags($parent, BatchEditTagsApiObservationsRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('batchEditTags', [$params], BatchEditTagsApiObservationsResponse::class);
}
/**
* GetApiObservation retrieves a single ApiObservation by name.
* (apiObservations.get)
*
* @param string $name Required. The name of the ApiObservation to retrieve.
* Format: projects/{project}/locations/{location}/observationJobs/{observation_
* job}/apiObservations/{api_observation}
* @param array $optParams Optional parameters.
* @return ApiObservation
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ApiObservation::class);
}
/**
* ListApiObservations gets all ApiObservations for a given project and location
* and ObservationJob.
* (apiObservations.listProjectsLocationsObservationJobsApiObservations)
*
* @param string $parent Required. The parent, which owns this collection of
* ApiObservations. Format:
* projects/{project}/locations/{location}/observationJobs/{observation_job}
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Optional. The maximum number of ApiObservations to
* return. The service may return fewer than this value. If unspecified, at most
* 10 ApiObservations will be returned. The maximum value is 1000; values above
* 1000 will be coerced to 1000.
* @opt_param string pageToken Optional. A page token, received from a previous
* `ListApiObservations` call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListApiObservations` must
* match the call that provided the page token.
* @return ListApiObservationsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsObservationJobsApiObservations($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListApiObservationsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsObservationJobsApiObservations::class, 'Google_Service_APIManagement_Resource_ProjectsLocationsObservationJobsApiObservations');
@@ -0,0 +1,79 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\APIManagement\Resource;
use Google\Service\APIManagement\ApiOperation;
use Google\Service\APIManagement\ListApiOperationsResponse;
/**
* The "apiOperations" collection of methods.
* Typical usage is:
* <code>
* $apimService = new Google\Service\APIManagement(...);
* $apiOperations = $apimService->projects_locations_observationJobs_apiObservations_apiOperations;
* </code>
*/
class ProjectsLocationsObservationJobsApiObservationsApiOperations extends \Google\Service\Resource
{
/**
* GetApiOperation retrieves a single ApiOperation by name. (apiOperations.get)
*
* @param string $name Required. The name of the ApiOperation to retrieve.
* Format: projects/{project}/locations/{location}/observationJobs/{observation_
* job}/apiObservations/{api_observation}/apiOperation/{api_operation}
* @param array $optParams Optional parameters.
* @return ApiOperation
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ApiOperation::class);
}
/**
* ListApiOperations gets all ApiOperations for a given project and location and
* ObservationJob and ApiObservation. (apiOperations.listProjectsLocationsObserv
* ationJobsApiObservationsApiOperations)
*
* @param string $parent Required. The parent, which owns this collection of
* ApiOperations. Format: projects/{project}/locations/{location}/observationJob
* s/{observation_job}/apiObservations/{api_observation}
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Optional. The maximum number of ApiOperations to
* return. The service may return fewer than this value. If unspecified, at most
* 10 ApiOperations will be returned. The maximum value is 1000; values above
* 1000 will be coerced to 1000.
* @opt_param string pageToken Optional. A page token, received from a previous
* `ListApiApiOperations` call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListApiApiOperations` must
* match the call that provided the page token.
* @return ListApiOperationsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsObservationJobsApiObservationsApiOperations($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListApiOperationsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsObservationJobsApiObservationsApiOperations::class, 'Google_Service_APIManagement_Resource_ProjectsLocationsObservationJobsApiObservationsApiOperations');
@@ -0,0 +1,128 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\APIManagement\Resource;
use Google\Service\APIManagement\ListObservationSourcesResponse;
use Google\Service\APIManagement\ObservationSource;
use Google\Service\APIManagement\Operation;
/**
* The "observationSources" collection of methods.
* Typical usage is:
* <code>
* $apimService = new Google\Service\APIManagement(...);
* $observationSources = $apimService->projects_locations_observationSources;
* </code>
*/
class ProjectsLocationsObservationSources extends \Google\Service\Resource
{
/**
* CreateObservationSource creates a new ObservationSource but does not affect
* any deployed infrastructure. It is a configuration that can be used in an
* Observation Job to collect data about APIs running in user's dataplane.
* (observationSources.create)
*
* @param string $parent Required. Value for parent.
* @param ObservationSource $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string observationSourceId Required. The ID to use for the
* Observation Source. This value should be 4-63 characters, and valid
* characters are /a-z-/.
* @opt_param string requestId Optional. An optional request ID to identify
* requests. Specify a unique request ID so that if you must retry your request,
* the server will know to ignore the request if it has already been completed.
* The server will guarantee that for at least 60 minutes since the first
* request. For example, consider a situation where you make an initial request
* and the request times out. If you make the request again with the same
* request ID, the server can check if original operation with the same request
* ID was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments. The request ID must
* be a valid UUID with the exception that zero UUID is not supported
* (00000000-0000-0000-0000-000000000000).
* @return Operation
* @throws \Google\Service\Exception
*/
public function create($parent, ObservationSource $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* DeleteObservationSource deletes an observation source. This method will fail
* if the observation source is currently being used by any ObservationJob, even
* if not enabled. (observationSources.delete)
*
* @param string $name Required. Name of the resource Format:
* projects/{project}/locations/{location}/observationSources/{source}
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* GetObservationSource retrieves a single ObservationSource by name.
* (observationSources.get)
*
* @param string $name Required. The name of the ObservationSource to retrieve.
* Format: projects/{project}/locations/{location}/observationSources/{source}
* @param array $optParams Optional parameters.
* @return ObservationSource
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ObservationSource::class);
}
/**
* ListObservationSources gets all ObservationSources for a given project and
* location. (observationSources.listProjectsLocationsObservationSources)
*
* @param string $parent Required. The parent, which owns this collection of
* ObservationSources. Format: projects/{project}/locations/{location}
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Optional. The maximum number of ObservationSources to
* return. The service may return fewer than this value. If unspecified, at most
* 10 ObservationSources will be returned. The maximum value is 1000; values
* above 1000 will be coerced to 1000.
* @opt_param string pageToken Optional. A page token, received from a previous
* `ListObservationSources` call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListObservationSources`
* must match the call that provided the page token.
* @return ListObservationSourcesResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsObservationSources($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListObservationSourcesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsObservationSources::class, 'Google_Service_APIManagement_Resource_ProjectsLocationsObservationSources');
@@ -0,0 +1,121 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\APIManagement\Resource;
use Google\Service\APIManagement\ApimEmpty;
use Google\Service\APIManagement\CancelOperationRequest;
use Google\Service\APIManagement\ListOperationsResponse;
use Google\Service\APIManagement\Operation;
/**
* The "operations" collection of methods.
* Typical usage is:
* <code>
* $apimService = new Google\Service\APIManagement(...);
* $operations = $apimService->projects_locations_operations;
* </code>
*/
class ProjectsLocationsOperations extends \Google\Service\Resource
{
/**
* Starts asynchronous cancellation on a long-running operation. The server
* makes a best effort to cancel the operation, but success is not guaranteed.
* If the server doesn't support this method, it returns
* `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or
* other methods to check whether the cancellation succeeded or whether the
* operation completed despite cancellation. On successful cancellation, the
* operation is not deleted; instead, it becomes an operation with an
* Operation.error value with a google.rpc.Status.code of `1`, corresponding to
* `Code.CANCELLED`. (operations.cancel)
*
* @param string $name The name of the operation resource to be cancelled.
* @param CancelOperationRequest $postBody
* @param array $optParams Optional parameters.
* @return ApimEmpty
* @throws \Google\Service\Exception
*/
public function cancel($name, CancelOperationRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('cancel', [$params], ApimEmpty::class);
}
/**
* Deletes a long-running operation. This method indicates that the client is no
* longer interested in the operation result. It does not cancel the operation.
* If the server doesn't support this method, it returns
* `google.rpc.Code.UNIMPLEMENTED`. (operations.delete)
*
* @param string $name The name of the operation resource to be deleted.
* @param array $optParams Optional parameters.
* @return ApimEmpty
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], ApimEmpty::class);
}
/**
* 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)
*
* @param string $name The name of the operation resource.
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Operation::class);
}
/**
* Lists operations that match the specified filter in the request. If the
* server doesn't support this method, it returns `UNIMPLEMENTED`.
* (operations.listProjectsLocationsOperations)
*
* @param string $name The name of the operation's parent resource.
* @param array $optParams Optional parameters.
*
* @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.
* @opt_param bool returnPartialSuccess When set to `true`, operations that are
* reachable are returned as normal, and those that are unreachable are returned
* in the ListOperationsResponse.unreachable field. This can only be `true` when
* reading across collections. For example, when `parent` is set to
* `"projects/example/locations/-"`. This field is not supported by default and
* will result in an `UNIMPLEMENTED` error if set unless explicitly documented
* otherwise in service or product specific documentation.
* @return ListOperationsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsOperations($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListOperationsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsOperations::class, 'Google_Service_APIManagement_Resource_ProjectsLocationsOperations');