Binary Authorization v1 API - Class ValidationHelperV1Client (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
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

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
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ValidationHelperV1 scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

The default ValidationHelperV1 scopes are:

GrpcClient

public virtual ValidationHelperV1.ValidationHelperV1Client GrpcClient { get; }

The underlying gRPC ValidationHelperV1 client

Property Value
TypeDescription
ValidationHelperV1.ValidationHelperV1Client

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
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
TypeDescription
ValidationHelperV1Client

The created ValidationHelperV1Client.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<ValidationHelperV1Client>

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
TypeDescription
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
NameDescription
requestValidateAttestationOccurrenceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestValidateAttestationOccurrenceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ValidateAttestationOccurrenceResponse>

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
NameDescription
requestValidateAttestationOccurrenceRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ValidateAttestationOccurrenceResponse>

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