File "ProjectsLocationsInstances.php"
Full Path: /home/palsarh/web/palsarh.in/public_html/vendor/google/apiclient-services/src/DataFusion/Resource/ProjectsLocationsInstances.php
File size: 9.92 KB
MIME-type: text/x-php
Charset: utf-8
<?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\DataFusion\Resource;
use Google\Service\DataFusion\Instance;
use Google\Service\DataFusion\ListInstancesResponse;
use Google\Service\DataFusion\Operation;
use Google\Service\DataFusion\Policy;
use Google\Service\DataFusion\RestartInstanceRequest;
use Google\Service\DataFusion\SetIamPolicyRequest;
use Google\Service\DataFusion\TestIamPermissionsRequest;
use Google\Service\DataFusion\TestIamPermissionsResponse;
/**
* The "instances" collection of methods.
* Typical usage is:
* <code>
* $datafusionService = new Google\Service\DataFusion(...);
* $instances = $datafusionService->projects_locations_instances;
* </code>
*/
class ProjectsLocationsInstances extends \Google\Service\Resource
{
/**
* Creates a new Data Fusion instance in the specified project and location.
* (instances.create)
*
* @param string $parent Required. The instance's project and location in the
* format projects/{project}/locations/{location}.
* @param Instance $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string instanceId Required. The name of the instance to create.
* Instance name can only contain lowercase alphanumeric characters and hyphens.
* It must start with a letter and must not end with a hyphen. It can have a
* maximum of 30 characters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function create($parent, Instance $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Deletes a single Date Fusion instance. (instances.delete)
*
* @param string $name Required. The instance resource name in the format
* projects/{project}/locations/{location}/instances/{instance}
* @param array $optParams Optional parameters.
*
* @opt_param bool force Optional. If set to true, any nested resources from
* this instance will also be deleted.
* @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);
}
/**
* Gets details of a single Data Fusion instance. (instances.get)
*
* @param string $name Required. The instance resource name in the format
* projects/{project}/locations/{location}/instances/{instance}.
* @param array $optParams Optional parameters.
* @return Instance
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Instance::class);
}
/**
* Gets the access control policy for a resource. Returns an empty policy if the
* resource exists and does not have a policy set. (instances.getIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param array $optParams Optional parameters.
*
* @opt_param int options.requestedPolicyVersion Optional. The maximum policy
* version that will be used to format the policy. Valid values are 0, 1, and 3.
* Requests specifying an invalid value will be rejected. Requests for policies
* with any conditional role bindings must specify version 3. Policies with no
* conditional role bindings may specify any valid value or leave the field
* unset. The policy in the response might use the policy version that you
* specified, or it might use a lower policy version. For example, if you
* specify version 3, but the policy has no conditional role bindings, the
* response uses version 1. To learn which resources support conditions in their
* IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
* @return Policy
* @throws \Google\Service\Exception
*/
public function getIamPolicy($resource, $optParams = [])
{
$params = ['resource' => $resource];
$params = array_merge($params, $optParams);
return $this->call('getIamPolicy', [$params], Policy::class);
}
/**
* Lists Data Fusion instances in the specified project and location.
* (instances.listProjectsLocationsInstances)
*
* @param string $parent Required. The project and location for which to
* retrieve instance information in the format
* projects/{project}/locations/{location}. If the location is specified as '-'
* (wildcard), then all regions available to the project are queried, and the
* results are aggregated.
* @param array $optParams Optional parameters.
*
* @opt_param string filter List filter.
* @opt_param string orderBy Sort results. Supported values are "name", "name
* desc", or "" (unsorted).
* @opt_param int pageSize The maximum number of items to return.
* @opt_param string pageToken The next_page_token value to use if there are
* additional results to retrieve for this list request.
* @return ListInstancesResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsInstances($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListInstancesResponse::class);
}
/**
* Updates a single Data Fusion instance. (instances.patch)
*
* @param string $name Output only. The name of this instance is in the form of
* projects/{project}/locations/{location}/instances/{instance}.
* @param Instance $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Field mask is used to specify the fields that
* the update will overwrite in an instance resource. The fields specified in
* the update_mask are relative to the resource, not the full request. A field
* will be overwritten if it is in the mask. If the user does not provide a
* mask, the label field will be overwritten.
* @return Operation
* @throws \Google\Service\Exception
*/
public function patch($name, Instance $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
/**
* Restart a single Data Fusion instance. At the end of an operation instance is
* fully restarted. (instances.restart)
*
* @param string $name Required. Name of the Data Fusion instance which need to
* be restarted in the form of
* projects/{project}/locations/{location}/instances/{instance}
* @param RestartInstanceRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function restart($name, RestartInstanceRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('restart', [$params], Operation::class);
}
/**
* Sets the access control policy on the specified resource. Replaces any
* existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
* `PERMISSION_DENIED` errors. (instances.setIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* specified. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param SetIamPolicyRequest $postBody
* @param array $optParams Optional parameters.
* @return Policy
* @throws \Google\Service\Exception
*/
public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setIamPolicy', [$params], Policy::class);
}
/**
* 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.
* This operation may "fail open" without warning.
* (instances.testIamPermissions)
*
* @param string $resource REQUIRED: The resource for which the policy detail is
* being requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param TestIamPermissionsRequest $postBody
* @param array $optParams Optional parameters.
* @return TestIamPermissionsResponse
* @throws \Google\Service\Exception
*/
public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsInstances::class, 'Google_Service_DataFusion_Resource_ProjectsLocationsInstances');