Class v1.BinauthzManagementServiceV1Client

Google Cloud Management Service for Binary Authorization admission policies and attestation authorities.

This API implements a REST model with the following objects:

* * v1

Package

@google-cloud/binary-authorization

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of BinauthzManagementServiceV1Client.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

binauthzManagementServiceV1Stub

binauthzManagementServiceV1Stub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(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.

createAttestor(request, options)

createAttestor(request?: protos.google.cloud.binaryauthorization.v1.ICreateAttestorRequest, options?: CallOptions): Promise<[
        protos.google.cloud.binaryauthorization.v1.IAttestor,
        (protos.google.cloud.binaryauthorization.v1.ICreateAttestorRequest | undefined),
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.ICreateAttestorRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.binaryauthorization.v1.IAttestor, (protos.google.cloud.binaryauthorization.v1.ICreateAttestorRequest | undefined), {} | undefined ]>

createAttestor(request, options, callback)

createAttestor(request: protos.google.cloud.binaryauthorization.v1.ICreateAttestorRequest, options: CallOptions, callback: Callback<protos.google.cloud.binaryauthorization.v1.IAttestor, protos.google.cloud.binaryauthorization.v1.ICreateAttestorRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.ICreateAttestorRequest
options CallOptions
callback Callback<protos.google.cloud.binaryauthorization.v1.IAttestor, protos.google.cloud.binaryauthorization.v1.ICreateAttestorRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createAttestor(request, callback)

createAttestor(request: protos.google.cloud.binaryauthorization.v1.ICreateAttestorRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1.IAttestor, protos.google.cloud.binaryauthorization.v1.ICreateAttestorRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.ICreateAttestorRequest
callback Callback<protos.google.cloud.binaryauthorization.v1.IAttestor, protos.google.cloud.binaryauthorization.v1.ICreateAttestorRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteAttestor(request, options)

deleteAttestor(request?: protos.google.cloud.binaryauthorization.v1.IDeleteAttestorRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.binaryauthorization.v1.IDeleteAttestorRequest | undefined),
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IDeleteAttestorRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.binaryauthorization.v1.IDeleteAttestorRequest | undefined), {} | undefined ]>

deleteAttestor(request, options, callback)

deleteAttestor(request: protos.google.cloud.binaryauthorization.v1.IDeleteAttestorRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.binaryauthorization.v1.IDeleteAttestorRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IDeleteAttestorRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.binaryauthorization.v1.IDeleteAttestorRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteAttestor(request, callback)

deleteAttestor(request: protos.google.cloud.binaryauthorization.v1.IDeleteAttestorRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.binaryauthorization.v1.IDeleteAttestorRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IDeleteAttestorRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.binaryauthorization.v1.IDeleteAttestorRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAttestor(request, options)

getAttestor(request?: protos.google.cloud.binaryauthorization.v1.IGetAttestorRequest, options?: CallOptions): Promise<[
        protos.google.cloud.binaryauthorization.v1.IAttestor,
        (protos.google.cloud.binaryauthorization.v1.IGetAttestorRequest | undefined),
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IGetAttestorRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.binaryauthorization.v1.IAttestor, (protos.google.cloud.binaryauthorization.v1.IGetAttestorRequest | undefined), {} | undefined ]>

getAttestor(request, options, callback)

getAttestor(request: protos.google.cloud.binaryauthorization.v1.IGetAttestorRequest, options: CallOptions, callback: Callback<protos.google.cloud.binaryauthorization.v1.IAttestor, protos.google.cloud.binaryauthorization.v1.IGetAttestorRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IGetAttestorRequest
options CallOptions
callback Callback<protos.google.cloud.binaryauthorization.v1.IAttestor, protos.google.cloud.binaryauthorization.v1.IGetAttestorRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAttestor(request, callback)

getAttestor(request: protos.google.cloud.binaryauthorization.v1.IGetAttestorRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1.IAttestor, protos.google.cloud.binaryauthorization.v1.IGetAttestorRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IGetAttestorRequest
callback Callback<protos.google.cloud.binaryauthorization.v1.IAttestor, protos.google.cloud.binaryauthorization.v1.IGetAttestorRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getPolicy(request, options)

getPolicy(request?: protos.google.cloud.binaryauthorization.v1.IGetPolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.binaryauthorization.v1.IPolicy,
        protos.google.cloud.binaryauthorization.v1.IGetPolicyRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IGetPolicyRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IGetPolicyRequest | undefined, {} | undefined ]>

getPolicy(request, options, callback)

getPolicy(request: protos.google.cloud.binaryauthorization.v1.IGetPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IGetPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IGetPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IGetPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getPolicy(request, callback)

getPolicy(request: protos.google.cloud.binaryauthorization.v1.IGetPolicyRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IGetPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IGetPolicyRequest
callback Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IGetPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

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.

listAttestors(request, options)

listAttestors(request?: protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.binaryauthorization.v1.IAttestor[],
        protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest | null,
        protos.google.cloud.binaryauthorization.v1.IListAttestorsResponse
    ]>;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.binaryauthorization.v1.IAttestor[], protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest | null, protos.google.cloud.binaryauthorization.v1.IListAttestorsResponse ]>

listAttestors(request, options, callback)

listAttestors(request: protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest, protos.google.cloud.binaryauthorization.v1.IListAttestorsResponse | null | undefined, protos.google.cloud.binaryauthorization.v1.IAttestor>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest, protos.google.cloud.binaryauthorization.v1.IListAttestorsResponse | null | undefined, protos.google.cloud.binaryauthorization.v1.IAttestor>
Returns
Type Description
void

listAttestors(request, callback)

listAttestors(request: protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest, callback: PaginationCallback<protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest, protos.google.cloud.binaryauthorization.v1.IListAttestorsResponse | null | undefined, protos.google.cloud.binaryauthorization.v1.IAttestor>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest
callback PaginationCallback<protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest, protos.google.cloud.binaryauthorization.v1.IListAttestorsResponse | null | undefined, protos.google.cloud.binaryauthorization.v1.IAttestor>
Returns
Type Description
void

listAttestorsAsync(request, options)

listAttestorsAsync(request?: protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.binaryauthorization.v1.IAttestor>;

Equivalent to listAttestors, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.binaryauthorization.v1.IAttestor>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Attestor]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
Example

const iterable = client.listAttestorsAsync(request); for await (const response of iterable) { // process response }

listAttestorsStream(request, options)

listAttestorsStream(request?: protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IListAttestorsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Attestor] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAttestorsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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.

updateAttestor(request, options)

updateAttestor(request?: protos.google.cloud.binaryauthorization.v1.IUpdateAttestorRequest, options?: CallOptions): Promise<[
        protos.google.cloud.binaryauthorization.v1.IAttestor,
        (protos.google.cloud.binaryauthorization.v1.IUpdateAttestorRequest | undefined),
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IUpdateAttestorRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.binaryauthorization.v1.IAttestor, (protos.google.cloud.binaryauthorization.v1.IUpdateAttestorRequest | undefined), {} | undefined ]>

updateAttestor(request, options, callback)

updateAttestor(request: protos.google.cloud.binaryauthorization.v1.IUpdateAttestorRequest, options: CallOptions, callback: Callback<protos.google.cloud.binaryauthorization.v1.IAttestor, protos.google.cloud.binaryauthorization.v1.IUpdateAttestorRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IUpdateAttestorRequest
options CallOptions
callback Callback<protos.google.cloud.binaryauthorization.v1.IAttestor, protos.google.cloud.binaryauthorization.v1.IUpdateAttestorRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateAttestor(request, callback)

updateAttestor(request: protos.google.cloud.binaryauthorization.v1.IUpdateAttestorRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1.IAttestor, protos.google.cloud.binaryauthorization.v1.IUpdateAttestorRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IUpdateAttestorRequest
callback Callback<protos.google.cloud.binaryauthorization.v1.IAttestor, protos.google.cloud.binaryauthorization.v1.IUpdateAttestorRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updatePolicy(request, options)

updatePolicy(request?: protos.google.cloud.binaryauthorization.v1.IUpdatePolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.binaryauthorization.v1.IPolicy,
        (protos.google.cloud.binaryauthorization.v1.IUpdatePolicyRequest | undefined),
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IUpdatePolicyRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.binaryauthorization.v1.IPolicy, (protos.google.cloud.binaryauthorization.v1.IUpdatePolicyRequest | undefined), {} | undefined ]>

updatePolicy(request, options, callback)

updatePolicy(request: protos.google.cloud.binaryauthorization.v1.IUpdatePolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IUpdatePolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IUpdatePolicyRequest
options CallOptions
callback Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IUpdatePolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updatePolicy(request, callback)

updatePolicy(request: protos.google.cloud.binaryauthorization.v1.IUpdatePolicyRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IUpdatePolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.binaryauthorization.v1.IUpdatePolicyRequest
callback Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IUpdatePolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void