Documentation

Google_Service_BinaryAuthorization_Resource_ProjectsAttestors extends Google_Service_Resource
in package

The "attestors" collection of methods.

Typical usage is: $binaryauthorizationService = new Google_Service_BinaryAuthorization(...); $attestors = $binaryauthorizationService->attestors;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_BinaryAuthorization_Attestor
Creates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the attestor already exists. (attestors.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_BinaryAuthorization_BinaryauthorizationEmpty
Deletes an attestor. Returns NOT_FOUND if the attestor does not exist.
get()  : Google_Service_BinaryAuthorization_Attestor
Gets an attestor. Returns NOT_FOUND if the attestor does not exist.
getIamPolicy()  : Google_Service_BinaryAuthorization_IamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (attestors.getIamPolicy)
listProjectsAttestors()  : Google_Service_BinaryAuthorization_ListAttestorsResponse
Lists attestors. Returns INVALID_ARGUMENT if the project does not exist.
setIamPolicy()  : Google_Service_BinaryAuthorization_IamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (attestors.setIamPolicy)
testIamPermissions()  : Google_Service_BinaryAuthorization_TestIamPermissionsResponse
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.
update()  : Google_Service_BinaryAuthorization_Attestor
Updates an attestor. Returns NOT_FOUND if the attestor does not exist.
validateAttestationOccurrence()  : Google_Service_BinaryAuthorization_ValidateAttestationOccurrenceResponse
Returns whether the given Attestation for the given image URI was signed by the given Attestor (attestors.validateAttestationOccurrence)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

Creates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the attestor already exists. (attestors.create)

public create(string $parent, Google_Service_BinaryAuthorization_Attestor $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BinaryAuthorization_Attestor
Parameters
$parent : string

Required. The parent of this attestor.

$postBody : Google_Service_BinaryAuthorization_Attestor
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string attestorId Required. The attestors ID.

Return values
Google_Service_BinaryAuthorization_Attestor

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes an attestor. Returns NOT_FOUND if the attestor does not exist.

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BinaryAuthorization_BinaryauthorizationEmpty

(attestors.delete)

Parameters
$name : string

Required. The name of the attestors to delete, in the format projects/attestors.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_BinaryAuthorization_BinaryauthorizationEmpty

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (attestors.getIamPolicy)

public getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BinaryAuthorization_IamPolicy
Parameters
$resource : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- policies).

Return values
Google_Service_BinaryAuthorization_IamPolicy

listProjectsAttestors()

Lists attestors. Returns INVALID_ARGUMENT if the project does not exist.

public listProjectsAttestors(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BinaryAuthorization_ListAttestorsResponse

(attestors.listProjectsAttestors)

Parameters
$parent : string

Required. The resource name of the project associated with the attestors, in the format projects.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken A token identifying a page of results the server should return. Typically, this is the value of ListAttestorsResponse.next_page_token returned from the previous call to the ListAttestors method.

opt_param

int pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

Return values
Google_Service_BinaryAuthorization_ListAttestorsResponse

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (attestors.setIamPolicy)

public setIamPolicy(string $resource, Google_Service_BinaryAuthorization_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BinaryAuthorization_IamPolicy
Parameters
$resource : string

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

$postBody : Google_Service_BinaryAuthorization_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_BinaryAuthorization_IamPolicy

testIamPermissions()

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.

public testIamPermissions(string $resource, Google_Service_BinaryAuthorization_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BinaryAuthorization_TestIamPermissionsResponse

This operation may "fail open" without warning. (attestors.testIamPermissions)

Parameters
$resource : string

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

$postBody : Google_Service_BinaryAuthorization_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_BinaryAuthorization_TestIamPermissionsResponse

update()

Updates an attestor. Returns NOT_FOUND if the attestor does not exist.

public update(string $name, Google_Service_BinaryAuthorization_Attestor $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BinaryAuthorization_Attestor

(attestors.update)

Parameters
$name : string

Required. The resource name, in the format: projects/attestors. This field may not be updated.

$postBody : Google_Service_BinaryAuthorization_Attestor
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_BinaryAuthorization_Attestor

validateAttestationOccurrence()

Returns whether the given Attestation for the given image URI was signed by the given Attestor (attestors.validateAttestationOccurrence)

public validateAttestationOccurrence(string $attestor, Google_Service_BinaryAuthorization_ValidateAttestationOccurrenceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BinaryAuthorization_ValidateAttestationOccurrenceResponse
Parameters
$attestor : string

Required. The resource name of the Attestor of the occurrence, in the format projects/attestors.

$postBody : Google_Service_BinaryAuthorization_ValidateAttestationOccurrenceRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_BinaryAuthorization_ValidateAttestationOccurrenceResponse

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results