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-authorizationConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of BinauthzManagementServiceV1Beta1Client.
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;
binauthzManagementServiceV1Beta1Stub
binauthzManagementServiceV1Beta1Stub?: Promise<{
[name: string]: Function;
}>;
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.
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. |
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
]>;
Creates an , and returns a copy of the new . Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the already exists.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.binaryauthorization.v1beta1.IAttestor,
(protos.google.cloud.binaryauthorization.v1beta1.ICreateAttestorRequest | 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 parent of this attestor google.cloud.binaryauthorization.v1beta1.Attestor.
*/
// const parent = 'abc123'
/**
* Required. The attestors google.cloud.binaryauthorization.v1beta1.Attestor ID.
*/
// const attestorId = 'abc123'
/**
* Required. The initial attestor google.cloud.binaryauthorization.v1beta1.Attestor value. The service will
* overwrite the attestor name google.cloud.binaryauthorization.v1beta1.Attestor.name field with the resource name,
* in the format `projects/* /attestors/*`.
*/
// const attestor = {}
// Imports the Binaryauthorization library
const {BinauthzManagementServiceV1Beta1Client} = require('@google-cloud/binary-authorization').v1beta1;
// Instantiates a client
const binaryauthorizationClient = new BinauthzManagementServiceV1Beta1Client();
async function callCreateAttestor() {
// Construct request
const request = {
parent,
attestorId,
attestor,
};
// Run request
const response = await binaryauthorizationClient.createAttestor(request);
console.log(response);
}
callCreateAttestor();
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 | |
---|---|
Name | Description |
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>
|
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 | |
---|---|
Name | Description |
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>
|
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
]>;
Deletes an . Returns NOT_FOUND if the does not exist.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest | 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 name of the attestors google.cloud.binaryauthorization.v1beta1.Attestor to delete, in the format
* `projects/* /attestors/*`.
*/
// const name = 'abc123'
// Imports the Binaryauthorization library
const {BinauthzManagementServiceV1Beta1Client} = require('@google-cloud/binary-authorization').v1beta1;
// Instantiates a client
const binaryauthorizationClient = new BinauthzManagementServiceV1Beta1Client();
async function callDeleteAttestor() {
// Construct request
const request = {
name,
};
// Run request
const response = await binaryauthorizationClient.deleteAttestor(request);
console.log(response);
}
callDeleteAttestor();
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 | |
---|---|
Name | Description |
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>
|
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 | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.binaryauthorization.v1beta1.IDeleteAttestorRequest | null | undefined, {} | null | undefined>
|
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
]>;
Gets an . Returns NOT_FOUND if the does not exist.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.binaryauthorization.v1beta1.IAttestor,
(protos.google.cloud.binaryauthorization.v1beta1.IGetAttestorRequest | 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 name of the attestor google.cloud.binaryauthorization.v1beta1.Attestor to retrieve, in the format
* `projects/* /attestors/*`.
*/
// const name = 'abc123'
// Imports the Binaryauthorization library
const {BinauthzManagementServiceV1Beta1Client} = require('@google-cloud/binary-authorization').v1beta1;
// Instantiates a client
const binaryauthorizationClient = new BinauthzManagementServiceV1Beta1Client();
async function callGetAttestor() {
// Construct request
const request = {
name,
};
// Run request
const response = await binaryauthorizationClient.getAttestor(request);
console.log(response);
}
callGetAttestor();
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 | |
---|---|
Name | Description |
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>
|
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 | |
---|---|
Name | Description |
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>
|
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
]>;
A specifies the that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy.
Gets the for this project. Returns a default if the project does not have one.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.binaryauthorization.v1beta1.IPolicy,
(protos.google.cloud.binaryauthorization.v1beta1.IGetPolicyRequest | 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 policy google.cloud.binaryauthorization.v1beta1.Policy to retrieve,
* in the format `projects/* /policy`.
*/
// const name = 'abc123'
// Imports the Binaryauthorization library
const {BinauthzManagementServiceV1Beta1Client} = require('@google-cloud/binary-authorization').v1beta1;
// Instantiates a client
const binaryauthorizationClient = new BinauthzManagementServiceV1Beta1Client();
async function callGetPolicy() {
// Construct request
const request = {
name,
};
// Run request
const response = await binaryauthorizationClient.getPolicy(request);
console.log(response);
}
callGetPolicy();
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 | |
---|---|
Name | Description |
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>
|
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 | |
---|---|
Name | Description |
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>
|
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.v1beta1.IListAttestorsRequest, options?: CallOptions): Promise<[
protos.google.cloud.binaryauthorization.v1beta1.IAttestor[],
protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest | null,
protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsResponse
]>;
Lists . Returns INVALID_ARGUMENT if the project does not exist.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.binaryauthorization.v1beta1.IAttestor[],
protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsRequest | null,
protos.google.cloud.binaryauthorization.v1beta1.IListAttestorsResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
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 | |
---|---|
Name | Description |
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>
|
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 | |
---|---|
Name | Description |
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>
|
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 | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1beta1.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.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 . 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. |
/**
* 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 project associated with the
* attestors google.cloud.binaryauthorization.v1beta1.Attestor, in the format `projects/*`.
*/
// const parent = 'abc123'
/**
* Requested page size. The server may return fewer results than requested. If
* unspecified, the server will pick an appropriate default.
*/
// const pageSize = 1234
/**
* A token identifying a page of results the server should return. Typically,
* this is the value of ListAttestorsResponse.next_page_token google.cloud.binaryauthorization.v1beta1.ListAttestorsResponse.next_page_token returned
* from the previous call to the `ListAttestors` method.
*/
// const pageToken = 'abc123'
// Imports the Binaryauthorization library
const {BinauthzManagementServiceV1Beta1Client} = require('@google-cloud/binary-authorization').v1beta1;
// Instantiates a client
const binaryauthorizationClient = new BinauthzManagementServiceV1Beta1Client();
async function callListAttestors() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await binaryauthorizationClient.listAttestorsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAttestors();
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 | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1beta1.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 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 |
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.v1beta1.IUpdateAttestorRequest, options?: CallOptions): Promise<[
protos.google.cloud.binaryauthorization.v1beta1.IAttestor,
(protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest | undefined),
{} | undefined
]>;
Updates an . Returns NOT_FOUND if the does not exist.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.binaryauthorization.v1beta1.IAttestor,
(protos.google.cloud.binaryauthorization.v1beta1.IUpdateAttestorRequest | 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 updated attestor google.cloud.binaryauthorization.v1beta1.Attestor value. The service will
* overwrite the attestor name google.cloud.binaryauthorization.v1beta1.Attestor.name field with the resource name
* in the request URL, in the format `projects/* /attestors/*`.
*/
// const attestor = {}
// Imports the Binaryauthorization library
const {BinauthzManagementServiceV1Beta1Client} = require('@google-cloud/binary-authorization').v1beta1;
// Instantiates a client
const binaryauthorizationClient = new BinauthzManagementServiceV1Beta1Client();
async function callUpdateAttestor() {
// Construct request
const request = {
attestor,
};
// Run request
const response = await binaryauthorizationClient.updateAttestor(request);
console.log(response);
}
callUpdateAttestor();
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 | |
---|---|
Name | Description |
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>
|
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 | |
---|---|
Name | Description |
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>
|
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
]>;
Creates or updates a project's , and returns a copy of the new . A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.binaryauthorization.v1beta1.IPolicy,
(protos.google.cloud.binaryauthorization.v1beta1.IUpdatePolicyRequest | 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. A new or updated policy google.cloud.binaryauthorization.v1beta1.Policy value. The service will
* overwrite the policy name google.cloud.binaryauthorization.v1beta1.Policy.name field with the resource name in
* the request URL, in the format `projects/* /policy`.
*/
// const policy = {}
// Imports the Binaryauthorization library
const {BinauthzManagementServiceV1Beta1Client} = require('@google-cloud/binary-authorization').v1beta1;
// Instantiates a client
const binaryauthorizationClient = new BinauthzManagementServiceV1Beta1Client();
async function callUpdatePolicy() {
// Construct request
const request = {
policy,
};
// Run request
const response = await binaryauthorizationClient.updatePolicy(request);
console.log(response);
}
callUpdatePolicy();
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 | |
---|---|
Name | Description |
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>
|
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 | |
---|---|
Name | Description |
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>
|
Returns | |
---|---|
Type | Description |
void |