BinAuthz Attestor verification v1
Package
@google-cloud/binary-authorizationConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of ValidationHelperV1Client.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof gax.fallback
: loaded instance of |
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
validationHelperV1Stub
validationHelperV1Stub?: Promise<{
[name: string]: Function;
}>;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
attestorPath(project, attestor)
attestorPath(project: string, attestor: string): string;
Return a fully-qualified attestor resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
attestor |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
getProjectId()
getProjectId(): Promise<string>;
Returns | |
---|---|
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter | |
---|---|
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns | |
---|---|
Type | Description |
void |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns | |
---|---|
Type | Description |
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub. |
locationPolicyPath(location)
locationPolicyPath(location: string): string;
Return a fully-qualified locationPolicy resource name string.
Parameter | |
---|---|
Name | Description |
location |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
matchAttestorFromAttestorName(attestorName)
matchAttestorFromAttestorName(attestorName: string): string | number;
Parse the attestor from Attestor resource.
Parameter | |
---|---|
Name | Description |
attestorName |
string
A fully-qualified path representing Attestor resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the attestor. |
matchLocationFromLocationPolicyName(locationPolicyName)
matchLocationFromLocationPolicyName(locationPolicyName: string): string | number;
Parse the location from LocationPolicy resource.
Parameter | |
---|---|
Name | Description |
locationPolicyName |
string
A fully-qualified path representing location_policy resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchProjectFromAttestorName(attestorName)
matchProjectFromAttestorName(attestorName: string): string | number;
Parse the project from Attestor resource.
Parameter | |
---|---|
Name | Description |
attestorName |
string
A fully-qualified path representing Attestor resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;
Parse the project from Project resource.
Parameter | |
---|---|
Name | Description |
projectName |
string
A fully-qualified path representing Project resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectPolicyName(projectPolicyName)
matchProjectFromProjectPolicyName(projectPolicyName: string): string | number;
Parse the project from ProjectPolicy resource.
Parameter | |
---|---|
Name | Description |
projectPolicyName |
string
A fully-qualified path representing project_policy resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
projectPath(project)
projectPath(project: string): string;
Return a fully-qualified project resource name string.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectPolicyPath(project)
projectPolicyPath(project: string): string;
Return a fully-qualified projectPolicy resource name string.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
validateAttestationOccurrence(request, options)
validateAttestationOccurrence(request?: protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceRequest, options?: CallOptions): Promise<[
protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceResponse,
(protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceRequest | undefined),
{} | undefined
]>;
Returns whether the given Attestation for the given image URI was signed by the given Attestor
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceResponse,
(protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* This snippet 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the Attestor google.cloud.binaryauthorization.v1.Attestor of the
* occurrence grafeas.v1.Occurrence, in the format
* `projects/* /attestors/*`.
*/
// const attestor = 'abc123'
/**
* Required. An AttestationOccurrence grafeas.v1.AttestationOccurrence to
* be checked that it can be verified by the Attestor. It does not have to be
* an existing entity in Container Analysis. It must otherwise be a valid
* AttestationOccurrence.
*/
// const attestation = {}
/**
* Required. The resource name of the Note grafeas.v1.Note to which the
* containing Occurrence grafeas.v1.Occurrence is associated.
*/
// const occurrenceNote = 'abc123'
/**
* Required. The URI of the artifact (e.g. container image) that is the
* subject of the containing Occurrence grafeas.v1.Occurrence.
*/
// const occurrenceResourceUri = 'abc123'
// Imports the Binaryauthorization library
const {ValidationHelperV1Client} = require('@google-cloud/binary-authorization').v1;
// Instantiates a client
const binaryauthorizationClient = new ValidationHelperV1Client();
async function callValidateAttestationOccurrence() {
// Construct request
const request = {
attestor,
attestation,
occurrenceNote,
occurrenceResourceUri,
};
// Run request
const response = await binaryauthorizationClient.validateAttestationOccurrence(request);
console.log(response);
}
callValidateAttestationOccurrence();
validateAttestationOccurrence(request, options, callback)
validateAttestationOccurrence(request: protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceRequest, options: CallOptions, callback: Callback<protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceResponse, protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceResponse, protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
validateAttestationOccurrence(request, callback)
validateAttestationOccurrence(request: protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceResponse, protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceRequest
|
callback |
Callback<protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceResponse, protos.google.cloud.binaryauthorization.v1.IValidateAttestationOccurrenceRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |