Reference documentation and code samples for the Google Cloud Binary Authorization V1 Client class ValidationHelperV1Client.
Service Description: BinAuthz Attestor verification
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Namespace
Google \ Cloud \ BinaryAuthorization \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
validateAttestationOccurrence
Returns whether the given Attestation for the given image URI was signed by the given Attestor
The async variant is ValidationHelperV1Client::validateAttestationOccurrenceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BinaryAuthorization\V1\ValidateAttestationOccurrenceRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\BinaryAuthorization\V1\ValidateAttestationOccurrenceResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\BinaryAuthorization\V1\Client\ValidationHelperV1Client;
use Google\Cloud\BinaryAuthorization\V1\ValidateAttestationOccurrenceRequest;
use Google\Cloud\BinaryAuthorization\V1\ValidateAttestationOccurrenceResponse;
use Grafeas\V1\AttestationOccurrence;
/**
* @param string $attestor The resource name of the [Attestor][google.cloud.binaryauthorization.v1.Attestor] of the
* [occurrence][grafeas.v1.Occurrence], in the format
* `projects/*/attestors/*`.
* @param string $occurrenceNote The resource name of the [Note][grafeas.v1.Note] to which the
* containing [Occurrence][grafeas.v1.Occurrence] is associated.
* @param string $occurrenceResourceUri The URI of the artifact (e.g. container image) that is the
* subject of the containing [Occurrence][grafeas.v1.Occurrence].
*/
function validate_attestation_occurrence_sample(
string $attestor,
string $occurrenceNote,
string $occurrenceResourceUri
): void {
// Create a client.
$validationHelperV1Client = new ValidationHelperV1Client();
// Prepare the request message.
$attestation = new AttestationOccurrence();
$request = (new ValidateAttestationOccurrenceRequest())
->setAttestor($attestor)
->setAttestation($attestation)
->setOccurrenceNote($occurrenceNote)
->setOccurrenceResourceUri($occurrenceResourceUri);
// Call the API and handle any network failures.
try {
/** @var ValidateAttestationOccurrenceResponse $response */
$response = $validationHelperV1Client->validateAttestationOccurrence($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$attestor = '[ATTESTOR]';
$occurrenceNote = '[OCCURRENCE_NOTE]';
$occurrenceResourceUri = '[OCCURRENCE_RESOURCE_URI]';
validate_attestation_occurrence_sample($attestor, $occurrenceNote, $occurrenceResourceUri);
}
validateAttestationOccurrenceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BinaryAuthorization\V1\ValidateAttestationOccurrenceRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\BinaryAuthorization\V1\ValidateAttestationOccurrenceResponse> |