231 lines
9.6 KiB
PHP
Executable File
231 lines
9.6 KiB
PHP
Executable File
<?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\ApigeeRegistry\Resource;
|
|
|
|
use Google\Service\ApigeeRegistry\ApigeeregistryEmpty;
|
|
use Google\Service\ApigeeRegistry\Artifact;
|
|
use Google\Service\ApigeeRegistry\HttpBody;
|
|
use Google\Service\ApigeeRegistry\ListArtifactsResponse;
|
|
use Google\Service\ApigeeRegistry\Policy;
|
|
use Google\Service\ApigeeRegistry\SetIamPolicyRequest;
|
|
use Google\Service\ApigeeRegistry\TestIamPermissionsRequest;
|
|
use Google\Service\ApigeeRegistry\TestIamPermissionsResponse;
|
|
|
|
/**
|
|
* The "artifacts" collection of methods.
|
|
* Typical usage is:
|
|
* <code>
|
|
* $apigeeregistryService = new Google\Service\ApigeeRegistry(...);
|
|
* $artifacts = $apigeeregistryService->projects_locations_apis_artifacts;
|
|
* </code>
|
|
*/
|
|
class ProjectsLocationsApisArtifacts extends \Google\Service\Resource
|
|
{
|
|
/**
|
|
* Creates a specified artifact. (artifacts.create)
|
|
*
|
|
* @param string $parent Required. The parent, which owns this collection of
|
|
* artifacts. Format: `{parent}`
|
|
* @param Artifact $postBody
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string artifactId Required. The ID to use for the artifact, which
|
|
* will become the final component of the artifact's resource name. This value
|
|
* should be 4-63 characters, and valid characters are /a-z-/. Following
|
|
* AIP-162, IDs must not have the form of a UUID.
|
|
* @return Artifact
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function create($parent, Artifact $postBody, $optParams = [])
|
|
{
|
|
$params = ['parent' => $parent, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('create', [$params], Artifact::class);
|
|
}
|
|
/**
|
|
* Removes a specified artifact. (artifacts.delete)
|
|
*
|
|
* @param string $name Required. The name of the artifact to delete. Format:
|
|
* `{parent}/artifacts`
|
|
* @param array $optParams Optional parameters.
|
|
* @return ApigeeregistryEmpty
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function delete($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('delete', [$params], ApigeeregistryEmpty::class);
|
|
}
|
|
/**
|
|
* Returns a specified artifact. (artifacts.get)
|
|
*
|
|
* @param string $name Required. The name of the artifact to retrieve. Format:
|
|
* `{parent}/artifacts`
|
|
* @param array $optParams Optional parameters.
|
|
* @return Artifact
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function get($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('get', [$params], Artifact::class);
|
|
}
|
|
/**
|
|
* Returns the contents of a specified artifact. If artifacts are stored with
|
|
* GZip compression, the default behavior is to return the artifact uncompressed
|
|
* (the mime_type response field indicates the exact format returned).
|
|
* (artifacts.getContents)
|
|
*
|
|
* @param string $name Required. The name of the artifact whose contents should
|
|
* be retrieved. Format: `{parent}/artifacts`
|
|
* @param array $optParams Optional parameters.
|
|
* @return HttpBody
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function getContents($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('getContents', [$params], HttpBody::class);
|
|
}
|
|
/**
|
|
* Gets the access control policy for a resource. Returns an empty policy if the
|
|
* resource exists and does not have a policy set. (artifacts.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);
|
|
}
|
|
/**
|
|
* Returns matching artifacts. (artifacts.listProjectsLocationsApisArtifacts)
|
|
*
|
|
* @param string $parent Required. The parent, which owns this collection of
|
|
* artifacts. Format: `{parent}`
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string filter An expression that can be used to filter the list.
|
|
* Filters use the Common Expression Language and can refer to all message
|
|
* fields except contents.
|
|
* @opt_param string orderBy A comma-separated list of fields, e.g. "foo,bar"
|
|
* Fields can be sorted in descending order using the "desc" identifier, e.g.
|
|
* "foo desc,bar"
|
|
* @opt_param int pageSize The maximum number of artifacts to return. The
|
|
* service may return fewer than this value. If unspecified, at most 50 values
|
|
* will be returned. The maximum is 1000; values above 1000 will be coerced to
|
|
* 1000.
|
|
* @opt_param string pageToken A page token, received from a previous
|
|
* `ListArtifacts` call. Provide this to retrieve the subsequent page. When
|
|
* paginating, all other parameters provided to `ListArtifacts` must match the
|
|
* call that provided the page token.
|
|
* @return ListArtifactsResponse
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function listProjectsLocationsApisArtifacts($parent, $optParams = [])
|
|
{
|
|
$params = ['parent' => $parent];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('list', [$params], ListArtifactsResponse::class);
|
|
}
|
|
/**
|
|
* Used to replace a specified artifact. (artifacts.replaceArtifact)
|
|
*
|
|
* @param string $name Resource name.
|
|
* @param Artifact $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return Artifact
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function replaceArtifact($name, Artifact $postBody, $optParams = [])
|
|
{
|
|
$params = ['name' => $name, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('replaceArtifact', [$params], Artifact::class);
|
|
}
|
|
/**
|
|
* Sets the access control policy on the specified resource. Replaces any
|
|
* existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
|
|
* `PERMISSION_DENIED` errors. (artifacts.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.
|
|
* (artifacts.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(ProjectsLocationsApisArtifacts::class, 'Google_Service_ApigeeRegistry_Resource_ProjectsLocationsApisArtifacts');
|