Class v1.SystemPolicyV1Client (2.5.0)

API for working with the system policy. v1

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of SystemPolicyV1Client.

Parameters
Name	Description
`opts`	`ClientOptions`
`gaxInstance`	`typeof gax \| typeof gax.fallback` : loaded instance of `google-gax`. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new SystemPolicyV1Client({fallback: 'rest'}, gax); ```

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.

systemPolicyV1Stub

systemPolicyV1Stub?: 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`

getSystemPolicy(request, options)

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

Gets the current system policy in the specified location.

Parameters
Name	Description
`request`	`protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest` 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.IPolicy, (protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest \| 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.

Example


  /**
   * 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, in the format `locations/* /policy`.
   *  Note that the system policy is not associated with a project.
   */
  // const name = 'abc123'

  // Imports the Binaryauthorization library
  const {SystemPolicyV1Client} = require('@google-cloud/binary-authorization').v1;

  // Instantiates a client
  const binaryauthorizationClient = new SystemPolicyV1Client();

  async function callGetSystemPolicy() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await binaryauthorizationClient.getSystemPolicy(request);
    console.log(response);
  }

  callGetSystemPolicy();

getSystemPolicy(request, options, callback)

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

Parameters
Name	Description
`request`	`protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getSystemPolicy(request, callback)

getSystemPolicy(request: protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest`
`callback`	`Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest \| null \| undefined, {} \| null \| 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.