Binary Authorization v1 API - Class ValidationHelperV1Client (2.3.0)

public abstract class ValidationHelperV1Client

Reference documentation and code samples for the Binary Authorization v1 API class ValidationHelperV1Client.

ValidationHelperV1 client wrapper, for convenient use.

Inheritance

object > ValidationHelperV1Client

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

ValidationHelperV1ClientImpl

Namespace

Google.Cloud.BinaryAuthorization.V1

Assembly

Google.Cloud.BinaryAuthorization.V1.dll

Remarks

BinAuthz Attestor verification

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ValidationHelperV1 service, which is a host of "binaryauthorization.googleapis.com" and a port of 443.

Property Value
Type	Description
`string`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ValidationHelperV1 scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default ValidationHelperV1 scopes are:

https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual ValidationHelperV1.ValidationHelperV1Client GrpcClient { get; }

The underlying gRPC ValidationHelperV1 client

Property Value
Type	Description
`ValidationHelperV1ValidationHelperV1Client`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

Methods

Create()

public static ValidationHelperV1Client Create()

Synchronously creates a ValidationHelperV1Client using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ValidationHelperV1ClientBuilder .

Returns
Type	Description
`ValidationHelperV1Client`	The created ValidationHelperV1Client.

CreateAsync(CancellationToken)

public static Task<ValidationHelperV1Client> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a ValidationHelperV1Client using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ValidationHelperV1ClientBuilder .

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`TaskValidationHelperV1Client`	The task representing the created ValidationHelperV1Client.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
`Task`	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

ValidateAttestationOccurrence(ValidateAttestationOccurrenceRequest, CallSettings)

public virtual ValidateAttestationOccurrenceResponse ValidateAttestationOccurrence(ValidateAttestationOccurrenceRequest request, CallSettings callSettings = null)

Returns whether the given Attestation for the given image URI was signed by the given Attestor

Parameters
Name	Description
`request`	`ValidateAttestationOccurrenceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ValidateAttestationOccurrenceResponse`	The RPC response.

Example

// Create client
ValidationHelperV1Client validationHelperV1Client = ValidationHelperV1Client.Create();
// Initialize request argument(s)
ValidateAttestationOccurrenceRequest request = new ValidateAttestationOccurrenceRequest
{
    Attestor = "",
    Attestation = new AttestationOccurrence(),
    OccurrenceNote = "",
    OccurrenceResourceUri = "",
};
// Make the request
ValidateAttestationOccurrenceResponse response = validationHelperV1Client.ValidateAttestationOccurrence(request);

ValidateAttestationOccurrenceAsync(ValidateAttestationOccurrenceRequest, CallSettings)

public virtual Task<ValidateAttestationOccurrenceResponse> ValidateAttestationOccurrenceAsync(ValidateAttestationOccurrenceRequest request, CallSettings callSettings = null)

Returns whether the given Attestation for the given image URI was signed by the given Attestor

Parameters
Name	Description
`request`	`ValidateAttestationOccurrenceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskValidateAttestationOccurrenceResponse`	A Task containing the RPC response.

Example

// Create client
ValidationHelperV1Client validationHelperV1Client = await ValidationHelperV1Client.CreateAsync();
// Initialize request argument(s)
ValidateAttestationOccurrenceRequest request = new ValidateAttestationOccurrenceRequest
{
    Attestor = "",
    Attestation = new AttestationOccurrence(),
    OccurrenceNote = "",
    OccurrenceResourceUri = "",
};
// Make the request
ValidateAttestationOccurrenceResponse response = await validationHelperV1Client.ValidateAttestationOccurrenceAsync(request);

ValidateAttestationOccurrenceAsync(ValidateAttestationOccurrenceRequest, CancellationToken)

public virtual Task<ValidateAttestationOccurrenceResponse> ValidateAttestationOccurrenceAsync(ValidateAttestationOccurrenceRequest request, CancellationToken cancellationToken)

Returns whether the given Attestation for the given image URI was signed by the given Attestor

Parameters
Name	Description
`request`	`ValidateAttestationOccurrenceRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskValidateAttestationOccurrenceResponse`	A Task containing the RPC response.

Example

// Create client
ValidationHelperV1Client validationHelperV1Client = await ValidationHelperV1Client.CreateAsync();
// Initialize request argument(s)
ValidateAttestationOccurrenceRequest request = new ValidateAttestationOccurrenceRequest
{
    Attestor = "",
    Attestation = new AttestationOccurrence(),
    OccurrenceNote = "",
    OccurrenceResourceUri = "",
};
// Make the request
ValidateAttestationOccurrenceResponse response = await validationHelperV1Client.ValidateAttestationOccurrenceAsync(request);