PolicyBasedRoutingServiceClient

PolicyBasedRoutingServiceClient

Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

Constructor

new PolicyBasedRoutingServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of PolicyBasedRoutingServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

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 PolicyBasedRoutingServiceClient({fallback: true}, gax);

Members

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

cancelOperation(request, optionsopt, callbackopt) → {Promise}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

(async) checkCreatePolicyBasedRouteProgress(name) → {Promise}

Check the status of the long running operation returned by createPolicyBasedRoute().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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 parent resource's name of the PolicyBasedRoute.
   */
  // const parent = 'abc123'
  /**
   *  Required. Unique id for the Policy Based Route to create.
   */
  // const policyBasedRouteId = 'abc123'
  /**
   *  Required. Initial values for a new Policy Based Route.
   */
  // const policyBasedRoute = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Networkconnectivity library
  const {PolicyBasedRoutingServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new PolicyBasedRoutingServiceClient();

  async function callCreatePolicyBasedRoute() {
    // Construct request
    const request = {
      parent,
      policyBasedRouteId,
      policyBasedRoute,
    };

    // Run request
    const [operation] = await networkconnectivityClient.createPolicyBasedRoute(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreatePolicyBasedRoute();

(async) checkDeletePolicyBasedRouteProgress(name) → {Promise}

Check the status of the long running operation returned by deletePolicyBasedRoute().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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. Name of the PolicyBasedRoute resource to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Networkconnectivity library
  const {PolicyBasedRoutingServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new PolicyBasedRoutingServiceClient();

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

    // Run request
    const [operation] = await networkconnectivityClient.deletePolicyBasedRoute(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeletePolicyBasedRoute();

close() → {Promise}

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

A promise that resolves when the client is closed.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

getIamPolicy(request, optionsopt, callbackopt) → {Promise}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options Object <optional>

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.

This object should have the same structure as GetPolicyOptions.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

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

The second parameter to the callback is an object representing Policy.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Policy. The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Resource name for the location.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.
Example
```
const [response] = await client.getLocation(request);
```

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

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

The second parameter to the callback is an object representing google.longrunning.Operation.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

groupPath(project, hub, group) → {string}

Return a fully-qualified group resource name string.

Parameters:
Name Type Description
project string
hub string
group string
Returns:
Type Description
string

Resource name string.

hubPath(project, hub) → {string}

Return a fully-qualified hub resource name string.

Parameters:
Name Type Description
project string
hub string
Returns:
Type Description
string

Resource name string.

hubRoutePath(project, hub, route_table, route) → {string}

Return a fully-qualified hubRoute resource name string.

Parameters:
Name Type Description
project string
hub string
route_table string
route string
Returns:
Type Description
string

Resource name string.

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

listLocationsAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The resource that owns the locations collection, if applicable.
filter string

The standard list filter.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. 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
}
```

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.
filter string

The standard list filter.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns:
Type Description
Object

An iterable Object that conforms to iteration protocols.
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

listPolicyBasedRoutesAsync(request, optionsopt) → {Object}

Equivalent to listPolicyBasedRoutes, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource's name.
pageSize number

The maximum number of results per page that should be returned.
pageToken string

The page token.
filter string

A filter expression that filters the results listed in the response.
orderBy string

Sort the results by a certain order.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing PolicyBasedRoute. 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 parent resource's name.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of results per page that should be returned.
   */
  // const pageSize = 1234
  /**
   *  The page token.
   */
  // const pageToken = 'abc123'
  /**
   *  A filter expression that filters the results listed in the response.
   */
  // const filter = 'abc123'
  /**
   *  Sort the results by a certain order.
   */
  // const orderBy = 'abc123'

  // Imports the Networkconnectivity library
  const {PolicyBasedRoutingServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new PolicyBasedRoutingServiceClient();

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

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

  callListPolicyBasedRoutes();

listPolicyBasedRoutesStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource's name.
pageSize number

The maximum number of results per page that should be returned.
pageToken string

The page token.
filter string

A filter expression that filters the results listed in the response.
orderBy string

Sort the results by a certain order.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing PolicyBasedRoute 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 listPolicyBasedRoutesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

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

Resource name string.

matchGroupFromGroupName(groupName) → {string}

Parse the group from Group resource.

Parameters:
Name Type Description
groupName string

A fully-qualified path representing Group resource.
Returns:
Type Description
string

A string representing the group.

matchHubFromGroupName(groupName) → {string}

Parse the hub from Group resource.

Parameters:
Name Type Description
groupName string

A fully-qualified path representing Group resource.
Returns:
Type Description
string

A string representing the hub.

matchHubFromHubName(hubName) → {string}

Parse the hub from Hub resource.

Parameters:
Name Type Description
hubName string

A fully-qualified path representing Hub resource.
Returns:
Type Description
string

A string representing the hub.

matchHubFromHubRouteName(hubRouteName) → {string}

Parse the hub from HubRoute resource.

Parameters:
Name Type Description
hubRouteName string

A fully-qualified path representing HubRoute resource.
Returns:
Type Description
string

A string representing the hub.

matchHubFromRouteTableName(routeTableName) → {string}

Parse the hub from RouteTable resource.

Parameters:
Name Type Description
routeTableName string

A fully-qualified path representing RouteTable resource.
Returns:
Type Description
string

A string representing the hub.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:
Name Type Description
locationName string

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

A string representing the location.

matchLocationFromSpokeName(spokeName) → {string}

Parse the location from Spoke resource.

Parameters:
Name Type Description
spokeName string

A fully-qualified path representing Spoke resource.
Returns:
Type Description
string

A string representing the location.

matchPolicyBasedRouteFromPolicyBasedRouteName(policyBasedRouteName) → {string}

Parse the policy_based_route from PolicyBasedRoute resource.

Parameters:
Name Type Description
policyBasedRouteName string

A fully-qualified path representing PolicyBasedRoute resource.
Returns:
Type Description
string

A string representing the policy_based_route.

matchProjectFromGroupName(groupName) → {string}

Parse the project from Group resource.

Parameters:
Name Type Description
groupName string

A fully-qualified path representing Group resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromHubName(hubName) → {string}

Parse the project from Hub resource.

Parameters:
Name Type Description
hubName string

A fully-qualified path representing Hub resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromHubRouteName(hubRouteName) → {string}

Parse the project from HubRoute resource.

Parameters:
Name Type Description
hubRouteName string

A fully-qualified path representing HubRoute resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:
Name Type Description
locationName string

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

A string representing the project.

matchProjectFromNetworkName(networkName) → {string}

Parse the project from Network resource.

Parameters:
Name Type Description
networkName string

A fully-qualified path representing Network resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromPolicyBasedRouteName(policyBasedRouteName) → {string}

Parse the project from PolicyBasedRoute resource.

Parameters:
Name Type Description
policyBasedRouteName string

A fully-qualified path representing PolicyBasedRoute resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromRouteTableName(routeTableName) → {string}

Parse the project from RouteTable resource.

Parameters:
Name Type Description
routeTableName string

A fully-qualified path representing RouteTable resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromSpokeName(spokeName) → {string}

Parse the project from Spoke resource.

Parameters:
Name Type Description
spokeName string

A fully-qualified path representing Spoke resource.
Returns:
Type Description
string

A string representing the project.

matchResourceIdFromNetworkName(networkName) → {string}

Parse the resource_id from Network resource.

Parameters:
Name Type Description
networkName string

A fully-qualified path representing Network resource.
Returns:
Type Description
string

A string representing the resource_id.

matchRouteFromHubRouteName(hubRouteName) → {string}

Parse the route from HubRoute resource.

Parameters:
Name Type Description
hubRouteName string

A fully-qualified path representing HubRoute resource.
Returns:
Type Description
string

A string representing the route.

matchRouteTableFromHubRouteName(hubRouteName) → {string}

Parse the route_table from HubRoute resource.

Parameters:
Name Type Description
hubRouteName string

A fully-qualified path representing HubRoute resource.
Returns:
Type Description
string

A string representing the route_table.

matchRouteTableFromRouteTableName(routeTableName) → {string}

Parse the route_table from RouteTable resource.

Parameters:
Name Type Description
routeTableName string

A fully-qualified path representing RouteTable resource.
Returns:
Type Description
string

A string representing the route_table.

matchSpokeFromSpokeName(spokeName) → {string}

Parse the spoke from Spoke resource.

Parameters:
Name Type Description
spokeName string

A fully-qualified path representing Spoke resource.
Returns:
Type Description
string

A string representing the spoke.

networkPath(project, resource_id) → {string}

Return a fully-qualified network resource name string.

Parameters:
Name Type Description
project string
resource_id string
Returns:
Type Description
string

Resource name string.

policyBasedRoutePath(project, policy_based_route) → {string}

Return a fully-qualified policyBasedRoute resource name string.

Parameters:
Name Type Description
project string
policy_based_route string
Returns:
Type Description
string

Resource name string.

routeTablePath(project, hub, route_table) → {string}

Return a fully-qualified routeTable resource name string.

Parameters:
Name Type Description
project string
hub string
route_table string
Returns:
Type Description
string

Resource name string.

setIamPolicy(request, optionsopt, callbackopt) → {Promise}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
resource string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions Array.<string>

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

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

The second parameter to the callback is an object representing TestIamPermissionsResponse.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.

spokePath(project, location, spoke) → {string}

Return a fully-qualified spoke resource name string.

Parameters:
Name Type Description
project string
location string
spoke string
Returns:
Type Description
string

Resource name string.

testIamPermissions(request, optionsopt, callbackopt) → {Promise}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
resource string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions Array.<string>

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

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

The second parameter to the callback is an object representing TestIamPermissionsResponse.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.