Class v1.BackupDrProtectionSummaryClient (0.8.0)

The Protection Summary service. v1

Package

@google-cloud/backupdr

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of BackupDrProtectionSummaryClient.

Parameters
Name Description
opts ClientOptions
gaxInstance typeof gax | typeof 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 BackupDrProtectionSummaryClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

backupDrProtectionSummaryStub

backupDrProtectionSummaryStub?: Promise<{
        [name: string]: Function;
    }>;

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

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.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

backupPath(project, location, backupvault, datasource, backup)

backupPath(project: string, location: string, backupvault: string, datasource: string, backup: string): string;

Return a fully-qualified backup resource name string.

Parameters
Name Description
project string
location string
backupvault string
datasource string
backup string
Returns
Type Description
string

{string} Resource name string.

backupPlanAssociationPath(project, location, backupPlanAssociation)

backupPlanAssociationPath(project: string, location: string, backupPlanAssociation: string): string;

Return a fully-qualified backupPlanAssociation resource name string.

Parameters
Name Description
project string
location string
backupPlanAssociation string
Returns
Type Description
string

{string} Resource name string.

backupPlanPath(project, location, backupPlan)

backupPlanPath(project: string, location: string, backupPlan: string): string;

Return a fully-qualified backupPlan resource name string.

Parameters
Name Description
project string
location string
backupPlan string
Returns
Type Description
string

{string} Resource name string.

backupPlanRevisionPath(project, location, backupPlan, revision)

backupPlanRevisionPath(project: string, location: string, backupPlan: string, revision: string): string;

Return a fully-qualified backupPlanRevision resource name string.

Parameters
Name Description
project string
location string
backupPlan string
revision string
Returns
Type Description
string

{string} Resource name string.

backupVaultPath(project, location, backupvault)

backupVaultPath(project: string, location: string, backupvault: string): string;

Return a fully-qualified backupVault resource name string.

Parameters
Name Description
project string
location string
backupvault 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.

dataSourcePath(project, location, backupvault, datasource)

dataSourcePath(project: string, location: string, backupvault: string, datasource: string): string;

Return a fully-qualified dataSource resource name string.

Parameters
Name Description
project string
location string
backupvault string
datasource string
Returns
Type Description
string

{string} Resource name string.

dataSourceReferencePath(project, location, dataSourceReference)

dataSourceReferencePath(project: string, location: string, dataSourceReference: string): string;

Return a fully-qualified dataSourceReference resource name string.

Parameters
Name Description
project string
location string
dataSourceReference string
Returns
Type Description
string

{string} Resource name string.

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name Description
request IamProtos.google.iam.v1.GetIamPolicyRequest

The request object that will be sent.
options CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .
Returns
Type Description
Promise<[google.iam.v1.Policy]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name Description
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.
options CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.
callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
Promise<google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

const [response] = await client.getLocation(request);

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.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

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

Parameters
Name Description
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<google.cloud.location.ILocation>

{Object} An iterable Object that allows async iteration. 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 for more details and examples.
Example 

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

listResourceBackupConfigs(request, options)

listResourceBackupConfigs(request?: protos.google.cloud.backupdr.v1.IListResourceBackupConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.backupdr.v1.IResourceBackupConfig[],
        protos.google.cloud.backupdr.v1.IListResourceBackupConfigsRequest | null,
        protos.google.cloud.backupdr.v1.IListResourceBackupConfigsResponse
    ]>;

Lists ResourceBackupConfigs.

Parameters
Name Description
request IListResourceBackupConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.backupdr.v1.IResourceBackupConfig[], protos.google.cloud.backupdr.v1.IListResourceBackupConfigsRequest | null, protos.google.cloud.backupdr.v1.IListResourceBackupConfigsResponse ]>

{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 listResourceBackupConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listResourceBackupConfigs(request, options, callback)

listResourceBackupConfigs(request: protos.google.cloud.backupdr.v1.IListResourceBackupConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.backupdr.v1.IListResourceBackupConfigsRequest, protos.google.cloud.backupdr.v1.IListResourceBackupConfigsResponse | null | undefined, protos.google.cloud.backupdr.v1.IResourceBackupConfig>): void;
Parameters
Name Description
request IListResourceBackupConfigsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.backupdr.v1.IListResourceBackupConfigsRequest, protos.google.cloud.backupdr.v1.IListResourceBackupConfigsResponse | null | undefined, protos.google.cloud.backupdr.v1.IResourceBackupConfig>
Returns
Type Description
void

listResourceBackupConfigs(request, callback)

listResourceBackupConfigs(request: protos.google.cloud.backupdr.v1.IListResourceBackupConfigsRequest, callback: PaginationCallback<protos.google.cloud.backupdr.v1.IListResourceBackupConfigsRequest, protos.google.cloud.backupdr.v1.IListResourceBackupConfigsResponse | null | undefined, protos.google.cloud.backupdr.v1.IResourceBackupConfig>): void;
Parameters
Name Description
request IListResourceBackupConfigsRequest
callback PaginationCallback<protos.google.cloud.backupdr.v1.IListResourceBackupConfigsRequest, protos.google.cloud.backupdr.v1.IListResourceBackupConfigsResponse | null | undefined, protos.google.cloud.backupdr.v1.IResourceBackupConfig>
Returns
Type Description
void

listResourceBackupConfigsAsync(request, options)

listResourceBackupConfigsAsync(request?: protos.google.cloud.backupdr.v1.IListResourceBackupConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.backupdr.v1.IResourceBackupConfig>;

Equivalent to listResourceBackupConfigs, but returns an iterable object.

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

Parameters
Name Description
request IListResourceBackupConfigsRequest

The request object that will be sent.
options CallOptions

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

{Object} An iterable Object that allows async iteration. 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 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 project and location for which to retrieve resource backup
   *  configs. Format: 'projects/{project_id}/locations/{location}'. In Google
   *  Cloud Backup and DR, locations map to Google Cloud regions, for example
   *  **us-central1**.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size. Server may return fewer items than
   *  requested. If unspecified, server will use 100 as default. Maximum value is
   *  500 and values above 500 will be coerced to 500.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filtering results.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Hint for how to order the results.
   */
  // const orderBy = 'abc123'

  // Imports the Backupdr library
  const {BackupDrProtectionSummaryClient} = require('@google-cloud/backupdr').v1;

  // Instantiates a client
  const backupdrClient = new BackupDrProtectionSummaryClient();

  async function callListResourceBackupConfigs() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = backupdrClient.listResourceBackupConfigsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListResourceBackupConfigs();

listResourceBackupConfigsStream(request, options)

listResourceBackupConfigsStream(request?: protos.google.cloud.backupdr.v1.IListResourceBackupConfigsRequest, options?: CallOptions): Transform;

Equivalent to listResourceBackupConfigs, but returns a NodeJS Stream object.

Parameters
Name Description
request IListResourceBackupConfigsRequest

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 listResourceBackupConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

managementServerPath(project, location, managementserver)

managementServerPath(project: string, location: string, managementserver: string): string;

Return a fully-qualified managementServer resource name string.

Parameters
Name Description
project string
location string
managementserver string
Returns
Type Description
string

{string} Resource name string.

matchBackupFromBackupName(backupName)

matchBackupFromBackupName(backupName: string): string | number;

Parse the backup from Backup resource.

Parameter
Name Description
backupName string

A fully-qualified path representing Backup resource.
Returns
Type Description
string | number

{string} A string representing the backup.

matchBackupPlanAssociationFromBackupPlanAssociationName(backupPlanAssociationName)

matchBackupPlanAssociationFromBackupPlanAssociationName(backupPlanAssociationName: string): string | number;

Parse the backup_plan_association from BackupPlanAssociation resource.

Parameter
Name Description
backupPlanAssociationName string

A fully-qualified path representing BackupPlanAssociation resource.
Returns
Type Description
string | number

{string} A string representing the backup_plan_association.

matchBackupPlanFromBackupPlanName(backupPlanName)

matchBackupPlanFromBackupPlanName(backupPlanName: string): string | number;

Parse the backup_plan from BackupPlan resource.

Parameter
Name Description
backupPlanName string

A fully-qualified path representing BackupPlan resource.
Returns
Type Description
string | number

{string} A string representing the backup_plan.

matchBackupPlanFromBackupPlanRevisionName(backupPlanRevisionName)

matchBackupPlanFromBackupPlanRevisionName(backupPlanRevisionName: string): string | number;

Parse the backup_plan from BackupPlanRevision resource.

Parameter
Name Description
backupPlanRevisionName string

A fully-qualified path representing BackupPlanRevision resource.
Returns
Type Description
string | number

{string} A string representing the backup_plan.

matchBackupvaultFromBackupName(backupName)

matchBackupvaultFromBackupName(backupName: string): string | number;

Parse the backupvault from Backup resource.

Parameter
Name Description
backupName string

A fully-qualified path representing Backup resource.
Returns
Type Description
string | number

{string} A string representing the backupvault.

matchBackupvaultFromBackupVaultName(backupVaultName)

matchBackupvaultFromBackupVaultName(backupVaultName: string): string | number;

Parse the backupvault from BackupVault resource.

Parameter
Name Description
backupVaultName string

A fully-qualified path representing BackupVault resource.
Returns
Type Description
string | number

{string} A string representing the backupvault.

matchBackupvaultFromDataSourceName(dataSourceName)

matchBackupvaultFromDataSourceName(dataSourceName: string): string | number;

Parse the backupvault from DataSource resource.

Parameter
Name Description
dataSourceName string

A fully-qualified path representing DataSource resource.
Returns
Type Description
string | number

{string} A string representing the backupvault.

matchDatasourceFromBackupName(backupName)

matchDatasourceFromBackupName(backupName: string): string | number;

Parse the datasource from Backup resource.

Parameter
Name Description
backupName string

A fully-qualified path representing Backup resource.
Returns
Type Description
string | number

{string} A string representing the datasource.

matchDatasourceFromDataSourceName(dataSourceName)

matchDatasourceFromDataSourceName(dataSourceName: string): string | number;

Parse the datasource from DataSource resource.

Parameter
Name Description
dataSourceName string

A fully-qualified path representing DataSource resource.
Returns
Type Description
string | number

{string} A string representing the datasource.

matchDataSourceReferenceFromDataSourceReferenceName(dataSourceReferenceName)

matchDataSourceReferenceFromDataSourceReferenceName(dataSourceReferenceName: string): string | number;

Parse the data_source_reference from DataSourceReference resource.

Parameter
Name Description
dataSourceReferenceName string

A fully-qualified path representing DataSourceReference resource.
Returns
Type Description
string | number

{string} A string representing the data_source_reference.

matchLocationFromBackupName(backupName)

matchLocationFromBackupName(backupName: string): string | number;

Parse the location from Backup resource.

Parameter
Name Description
backupName string

A fully-qualified path representing Backup resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromBackupPlanAssociationName(backupPlanAssociationName)

matchLocationFromBackupPlanAssociationName(backupPlanAssociationName: string): string | number;

Parse the location from BackupPlanAssociation resource.

Parameter
Name Description
backupPlanAssociationName string

A fully-qualified path representing BackupPlanAssociation resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromBackupPlanName(backupPlanName)

matchLocationFromBackupPlanName(backupPlanName: string): string | number;

Parse the location from BackupPlan resource.

Parameter
Name Description
backupPlanName string

A fully-qualified path representing BackupPlan resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromBackupPlanRevisionName(backupPlanRevisionName)

matchLocationFromBackupPlanRevisionName(backupPlanRevisionName: string): string | number;

Parse the location from BackupPlanRevision resource.

Parameter
Name Description
backupPlanRevisionName string

A fully-qualified path representing BackupPlanRevision resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromBackupVaultName(backupVaultName)

matchLocationFromBackupVaultName(backupVaultName: string): string | number;

Parse the location from BackupVault resource.

Parameter
Name Description
backupVaultName string

A fully-qualified path representing BackupVault resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDataSourceName(dataSourceName)

matchLocationFromDataSourceName(dataSourceName: string): string | number;

Parse the location from DataSource resource.

Parameter
Name Description
dataSourceName string

A fully-qualified path representing DataSource resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDataSourceReferenceName(dataSourceReferenceName)

matchLocationFromDataSourceReferenceName(dataSourceReferenceName: string): string | number;

Parse the location from DataSourceReference resource.

Parameter
Name Description
dataSourceReferenceName string

A fully-qualified path representing DataSourceReference resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromManagementServerName(managementServerName)

matchLocationFromManagementServerName(managementServerName: string): string | number;

Parse the location from ManagementServer resource.

Parameter
Name Description
managementServerName string

A fully-qualified path representing ManagementServer resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromResourceBackupConfigName(resourceBackupConfigName)

matchLocationFromResourceBackupConfigName(resourceBackupConfigName: string): string | number;

Parse the location from ResourceBackupConfig resource.

Parameter
Name Description
resourceBackupConfigName string

A fully-qualified path representing ResourceBackupConfig resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchManagementserverFromManagementServerName(managementServerName)

matchManagementserverFromManagementServerName(managementServerName: string): string | number;

Parse the managementserver from ManagementServer resource.

Parameter
Name Description
managementServerName string

A fully-qualified path representing ManagementServer resource.
Returns
Type Description
string | number

{string} A string representing the managementserver.

matchProjectFromBackupName(backupName)

matchProjectFromBackupName(backupName: string): string | number;

Parse the project from Backup resource.

Parameter
Name Description
backupName string

A fully-qualified path representing Backup resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromBackupPlanAssociationName(backupPlanAssociationName)

matchProjectFromBackupPlanAssociationName(backupPlanAssociationName: string): string | number;

Parse the project from BackupPlanAssociation resource.

Parameter
Name Description
backupPlanAssociationName string

A fully-qualified path representing BackupPlanAssociation resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromBackupPlanName(backupPlanName)

matchProjectFromBackupPlanName(backupPlanName: string): string | number;

Parse the project from BackupPlan resource.

Parameter
Name Description
backupPlanName string

A fully-qualified path representing BackupPlan resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromBackupPlanRevisionName(backupPlanRevisionName)

matchProjectFromBackupPlanRevisionName(backupPlanRevisionName: string): string | number;

Parse the project from BackupPlanRevision resource.

Parameter
Name Description
backupPlanRevisionName string

A fully-qualified path representing BackupPlanRevision resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromBackupVaultName(backupVaultName)

matchProjectFromBackupVaultName(backupVaultName: string): string | number;

Parse the project from BackupVault resource.

Parameter
Name Description
backupVaultName string

A fully-qualified path representing BackupVault resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDataSourceName(dataSourceName)

matchProjectFromDataSourceName(dataSourceName: string): string | number;

Parse the project from DataSource resource.

Parameter
Name Description
dataSourceName string

A fully-qualified path representing DataSource resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDataSourceReferenceName(dataSourceReferenceName)

matchProjectFromDataSourceReferenceName(dataSourceReferenceName: string): string | number;

Parse the project from DataSourceReference resource.

Parameter
Name Description
dataSourceReferenceName string

A fully-qualified path representing DataSourceReference resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromManagementServerName(managementServerName)

matchProjectFromManagementServerName(managementServerName: string): string | number;

Parse the project from ManagementServer resource.

Parameter
Name Description
managementServerName string

A fully-qualified path representing ManagementServer resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromResourceBackupConfigName(resourceBackupConfigName)

matchProjectFromResourceBackupConfigName(resourceBackupConfigName: string): string | number;

Parse the project from ResourceBackupConfig resource.

Parameter
Name Description
resourceBackupConfigName string

A fully-qualified path representing ResourceBackupConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchResourceBackupConfigFromResourceBackupConfigName(resourceBackupConfigName)

matchResourceBackupConfigFromResourceBackupConfigName(resourceBackupConfigName: string): string | number;

Parse the resource_backup_config from ResourceBackupConfig resource.

Parameter
Name Description
resourceBackupConfigName string

A fully-qualified path representing ResourceBackupConfig resource.
Returns
Type Description
string | number

{string} A string representing the resource_backup_config.

matchRevisionFromBackupPlanRevisionName(backupPlanRevisionName)

matchRevisionFromBackupPlanRevisionName(backupPlanRevisionName: string): string | number;

Parse the revision from BackupPlanRevision resource.

Parameter
Name Description
backupPlanRevisionName string

A fully-qualified path representing BackupPlanRevision resource.
Returns
Type Description
string | number

{string} A string representing the revision.

resourceBackupConfigPath(project, location, resourceBackupConfig)

resourceBackupConfigPath(project: string, location: string, resourceBackupConfig: string): string;

Return a fully-qualified resourceBackupConfig resource name string.

Parameters
Name Description
project string
location string
resourceBackupConfig string
Returns
Type Description
string

{string} Resource name string.

setIamPolicy(request, options, callback)

setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
request IamProtos.google.iam.v1.SetIamPolicyRequest

The request object that will be sent.
options CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .
Returns
Type Description
Promise<[google.iam.v1.Policy]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

testIamPermissions(request, options, callback)

testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
request IamProtos.google.iam.v1.TestIamPermissionsRequest

The request object that will be sent.
options CallOptions | Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .
Returns
Type Description
Promise<[google.iam.v1.TestIamPermissionsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.