Class v1beta1.BinauthzManagementServiceV1Beta1Client

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

This API implements a REST model with the following objects:

* * v1beta1

Package

@google-cloud/binary-authorization!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of BinauthzManagementServiceV1Beta1Client.

Parameter

Type	Name	Description
ClientOptions	opts

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

binauthzManagementServiceV1Beta1Stub

binauthzManagementServiceV1Beta1Stub?: 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

Type	Name	Description
string	project
string	attestor

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.v1beta1.ICreateAttestorRequest, options?: CallOptions): Promise<[
        protos.google.cloud.binaryauthorization.v1beta1.IAttestor,
        (protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest | undefined),
        {} | undefined
    ]>;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest	request
CallOptions	options

Returns

Type	Description
Promise<[ protos.google.cloud.binaryauthorization.v1beta1.IAttestor, (protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest \| undefined), {} \| undefined ]>

createAttestor(request, options, callback)

createAttestor(request: protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest, options: CallOptions, callback: Callback<protos.google.cloud.binaryauthorization.v1beta1.IAttestor, protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest	request
CallOptions	options
Callback<protos.google.cloud.binaryauthorization.v1beta1.IAttestor, protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

createAttestor(request, callback)

createAttestor(request: protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1beta1.IAttestor, protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest	request
Callback<protos.google.cloud.binaryauthorization.v1beta1.IAttestor, protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

deleteAttestor(request, options)

deleteAttestor(request?: protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest | undefined),
        {} | undefined
    ]>;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest	request
CallOptions	options

Returns

Type	Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest \| undefined), {} \| undefined ]>

deleteAttestor(request, options, callback)

deleteAttestor(request: protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest	request
CallOptions	options
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

deleteAttestor(request, callback)

deleteAttestor(request: protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest	request
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getAttestor(request, options)

getAttestor(request?: protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest, options?: CallOptions): Promise<[
        protos.google.cloud.binaryauthorization.v1beta1.IAttestor,
        (protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest | undefined),
        {} | undefined
    ]>;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest	request
CallOptions	options

Returns

Type	Description
Promise<[ protos.google.cloud.binaryauthorization.v1beta1.IAttestor, (protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest \| undefined), {} \| undefined ]>

getAttestor(request, options, callback)

getAttestor(request: protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest, options: CallOptions, callback: Callback<protos.google.cloud.binaryauthorization.v1beta1.IAttestor, protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest	request
CallOptions	options
Callback<protos.google.cloud.binaryauthorization.v1beta1.IAttestor, protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getAttestor(request, callback)

getAttestor(request: protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1beta1.IAttestor, protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest	request
Callback<protos.google.cloud.binaryauthorization.v1beta1.IAttestor, protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getPolicy(request, options)

getPolicy(request?: protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.binaryauthorization.v1beta1.IPolicy,
        (protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest | undefined),
        {} | undefined
    ]>;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest	request
CallOptions	options

Returns

Type	Description
Promise<[ protos.google.cloud.binaryauthorization.v1beta1.IPolicy, (protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest \| undefined), {} \| undefined ]>

getPolicy(request, options, callback)

getPolicy(request: protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.binaryauthorization.v1beta1.IPolicy, protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest	request
CallOptions	options
Callback<protos.google.cloud.binaryauthorization.v1beta1.IPolicy, protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getPolicy(request, callback)

getPolicy(request: protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1beta1.IPolicy, protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest	request
Callback<protos.google.cloud.binaryauthorization.v1beta1.IPolicy, protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Type	Name	Description
Callback<string, undefined, undefined>	callback

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.v1beta1.IListAttestorsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.binaryauthorization.v1beta1.IAttestor[],
        protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest | null,
        protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsResponse
    ]>;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest	request
CallOptions	options

Returns

Type	Description
Promise<[ protos.google.cloud.binaryauthorization.v1beta1.IAttestor[], protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest \| null, protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsResponse ]>

listAttestors(request, options, callback)

listAttestors(request: protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest, protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsResponse | null | undefined, protos.google.cloud.binaryauthorization.v1beta1.IAttestor>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest	request
CallOptions	options
PaginationCallback<protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest, protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsResponse \| null \| undefined, protos.google.cloud.binaryauthorization.v1beta1.IAttestor>	callback

Returns

Type	Description
void

listAttestors(request, callback)

listAttestors(request: protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest, callback: PaginationCallback<protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest, protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsResponse | null | undefined, protos.google.cloud.binaryauthorization.v1beta1.IAttestor>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest	request
PaginationCallback<protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest, protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsResponse \| null \| undefined, protos.google.cloud.binaryauthorization.v1beta1.IAttestor>	callback

Returns

Type	Description
void

listAttestorsAsync(request, options)

listAttestorsAsync(request?: protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.binaryauthorization.v1beta1.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

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type	Description
AsyncIterable<protos.google.cloud.binaryauthorization.v1beta1.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.

listAttestorsStream(request, options)

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

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

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest	request	The request object that will be sent.
CallOptions	options	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.

matchAttestorFromAttestorName(attestorName)

matchAttestorFromAttestorName(attestorName: string): string | number;

Parse the attestor from Attestor resource.

Parameter

Type	Name	Description
string	attestorName	A fully-qualified path representing Attestor resource.

Returns

Type	Description
string \| number	{string} A string representing the attestor.

matchProjectFromAttestorName(attestorName)

matchProjectFromAttestorName(attestorName: string): string | number;

Parse the project from Attestor resource.

Parameter

Type	Name	Description
string	attestorName	A fully-qualified path representing Attestor resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromPolicyName(policyName)

matchProjectFromPolicyName(policyName: string): string | number;

Parse the project from Policy resource.

Parameter

Type	Name	Description
string	policyName	A fully-qualified path representing Policy 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

Type	Name	Description
string	projectName	A fully-qualified path representing Project resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

policyPath(project)

policyPath(project: string): string;

Return a fully-qualified policy resource name string.

Parameter

Type	Name	Description
string	project

Returns

Type	Description
string	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Type	Name	Description
string	project

Returns

Type	Description
string	{string} Resource name string.

updateAttestor(request, options)

updateAttestor(request?: protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest, options?: CallOptions): Promise<[
        protos.google.cloud.binaryauthorization.v1beta1.IAttestor,
        (protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest | undefined),
        {} | undefined
    ]>;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest	request
CallOptions	options

Returns

Type	Description
Promise<[ protos.google.cloud.binaryauthorization.v1beta1.IAttestor, (protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest \| undefined), {} \| undefined ]>

updateAttestor(request, options, callback)

updateAttestor(request: protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest, options: CallOptions, callback: Callback<protos.google.cloud.binaryauthorization.v1beta1.IAttestor, protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest	request
CallOptions	options
Callback<protos.google.cloud.binaryauthorization.v1beta1.IAttestor, protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

updateAttestor(request, callback)

updateAttestor(request: protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1beta1.IAttestor, protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest	request
Callback<protos.google.cloud.binaryauthorization.v1beta1.IAttestor, protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

updatePolicy(request, options)

updatePolicy(request?: protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.binaryauthorization.v1beta1.IPolicy,
        (protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest | undefined),
        {} | undefined
    ]>;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest	request
CallOptions	options

Returns

Type	Description
Promise<[ protos.google.cloud.binaryauthorization.v1beta1.IPolicy, (protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest \| undefined), {} \| undefined ]>

updatePolicy(request, options, callback)

updatePolicy(request: protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.binaryauthorization.v1beta1.IPolicy, protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest	request
CallOptions	options
Callback<protos.google.cloud.binaryauthorization.v1beta1.IPolicy, protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

updatePolicy(request, callback)

updatePolicy(request: protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1beta1.IPolicy, protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest	request
Callback<protos.google.cloud.binaryauthorization.v1beta1.IPolicy, protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void