252 lines
12 KiB
PHP
252 lines
12 KiB
PHP
<?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\AppHub\Resource;
|
|
|
|
use Google\Service\AppHub\Application;
|
|
use Google\Service\AppHub\ListApplicationsResponse;
|
|
use Google\Service\AppHub\Operation;
|
|
use Google\Service\AppHub\Policy;
|
|
use Google\Service\AppHub\SetIamPolicyRequest;
|
|
use Google\Service\AppHub\TestIamPermissionsRequest;
|
|
use Google\Service\AppHub\TestIamPermissionsResponse;
|
|
|
|
/**
|
|
* The "applications" collection of methods.
|
|
* Typical usage is:
|
|
* <code>
|
|
* $apphubService = new Google\Service\AppHub(...);
|
|
* $applications = $apphubService->projects_locations_applications;
|
|
* </code>
|
|
*/
|
|
class ProjectsLocationsApplications extends \Google\Service\Resource
|
|
{
|
|
/**
|
|
* Creates an Application in a host project and location. (applications.create)
|
|
*
|
|
* @param string $parent Required. Project and location to create Application
|
|
* in. Expected format: `projects/{project}/locations/{location}`.
|
|
* @param Application $postBody
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string applicationId Required. The Application identifier. Must
|
|
* contain only lowercase letters, numbers or hyphens, with the first character
|
|
* a letter, the last a letter or a number, and a 63 character maximum.
|
|
* @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, Application $postBody, $optParams = [])
|
|
{
|
|
$params = ['parent' => $parent, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('create', [$params], Operation::class);
|
|
}
|
|
/**
|
|
* Deletes an Application in a host project and location. (applications.delete)
|
|
*
|
|
* @param string $name Required. Fully qualified name of the Application to
|
|
* delete. Expected format:
|
|
* `projects/{project}/locations/{location}/applications/{application}`.
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @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 after 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 delete($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('delete', [$params], Operation::class);
|
|
}
|
|
/**
|
|
* Gets an Application in a host project and location. (applications.get)
|
|
*
|
|
* @param string $name Required. Fully qualified name of the Application to
|
|
* fetch. Expected format:
|
|
* `projects/{project}/locations/{location}/applications/{application}`.
|
|
* @param array $optParams Optional parameters.
|
|
* @return Application
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function get($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('get', [$params], Application::class);
|
|
}
|
|
/**
|
|
* Gets the access control policy for a resource. Returns an empty policy if the
|
|
* resource exists and does not have a policy set. (applications.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 Applications in a host project and location.
|
|
* (applications.listProjectsLocationsApplications)
|
|
*
|
|
* @param string $parent Required. Project and location to list Applications on.
|
|
* Expected format: `projects/{project}/locations/{location}`.
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string filter Optional. Filtering results.
|
|
* @opt_param string orderBy Optional. Hint for how to order the results.
|
|
* @opt_param int pageSize Optional. Requested page size. Server may return
|
|
* fewer items than requested. If unspecified, server will pick an appropriate
|
|
* default.
|
|
* @opt_param string pageToken Optional. A token identifying a page of results
|
|
* the server should return.
|
|
* @return ListApplicationsResponse
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function listProjectsLocationsApplications($parent, $optParams = [])
|
|
{
|
|
$params = ['parent' => $parent];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('list', [$params], ListApplicationsResponse::class);
|
|
}
|
|
/**
|
|
* Updates an Application in a host project and location. (applications.patch)
|
|
*
|
|
* @param string $name Identifier. The resource name of an Application. Format:
|
|
* `"projects/{host-project-id}/locations/{location}/applications/{application-
|
|
* id}"`
|
|
* @param Application $postBody
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @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).
|
|
* @opt_param string updateMask Required. Field mask is used to specify the
|
|
* fields to be overwritten in the Application resource by the update. The
|
|
* fields specified in the update_mask are relative to the resource, not the
|
|
* full request. The API changes the values of the fields as specified in the
|
|
* update_mask. The API ignores the values of all fields not covered by the
|
|
* update_mask. You can also unset a field by not specifying it in the updated
|
|
* message, but adding the field to the mask. This clears whatever value the
|
|
* field previously had.
|
|
* @return Operation
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function patch($name, Application $postBody, $optParams = [])
|
|
{
|
|
$params = ['name' => $name, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('patch', [$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. (applications.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.
|
|
* (applications.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(ProjectsLocationsApplications::class, 'Google_Service_AppHub_Resource_ProjectsLocationsApplications');
|