class ProjectsLocationsApisVersionsSpecsArtifacts extends Resource (View source)

The "artifacts" collection of methods.

Typical usage is:

 $apigeeregistryService = new Google\Service\ApigeeRegistry(...);
 $artifacts = $apigeeregistryService->projects_locations_apis_versions_specs_artifacts;

Methods

create(string $parent, Artifact $postBody, array $optParams = [])

Creates a specified artifact. (artifacts.create)

delete(string $name, array $optParams = [])

Removes a specified artifact. (artifacts.delete)

get(string $name, array $optParams = [])

Returns a specified artifact. (artifacts.get)

getContents(string $name, array $optParams = [])

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).

getIamPolicy(string $resource, array $optParams = [])

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)

listProjectsLocationsApisVersionsSpecsArtifacts(string $parent, array $optParams = [])

Returns matching artifacts.

replaceArtifact(string $name, Artifact $postBody, array $optParams = [])

Used to replace a specified artifact. (artifacts.replaceArtifact)

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

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)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.

Details

Artifact create(string $parent, Artifact $postBody, array $optParams = [])

Creates a specified artifact. (artifacts.create)

Parameters

string $parent

Required. The parent, which owns this collection of artifacts. Format: {parent}

Artifact $postBody
array $optParams

Optional parameters.

Return Value

Artifact

Exceptions

Exception

ApigeeregistryEmpty delete(string $name, array $optParams = [])

Removes a specified artifact. (artifacts.delete)

Parameters

string $name

Required. The name of the artifact to delete. Format: {parent}/artifacts

array $optParams

Optional parameters.

Return Value

ApigeeregistryEmpty

Exceptions

Exception

Artifact get(string $name, array $optParams = [])

Returns a specified artifact. (artifacts.get)

Parameters

string $name

Required. The name of the artifact to retrieve. Format: {parent}/artifacts

array $optParams

Optional parameters.

Return Value

Artifact

Exceptions

Exception

HttpBody getContents(string $name, array $optParams = [])

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)

Parameters

string $name

Required. The name of the artifact whose contents should be retrieved. Format: {parent}/artifacts

array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception

Policy getIamPolicy(string $resource, array $optParams = [])

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)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

ListArtifactsResponse listProjectsLocationsApisVersionsSpecsArtifacts(string $parent, array $optParams = [])

Returns matching artifacts.

(artifacts.listProjectsLocationsApisVersionsSpecsArtifacts)

Parameters

string $parent

Required. The parent, which owns this collection of artifacts. Format: {parent}

array $optParams

Optional parameters.

Return Value

ListArtifactsResponse

Exceptions

Exception

Artifact replaceArtifact(string $name, Artifact $postBody, array $optParams = [])

Used to replace a specified artifact. (artifacts.replaceArtifact)

Parameters

string $name

Resource name.

Artifact $postBody
array $optParams

Optional parameters.

Return Value

Artifact

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

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)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception