InstanceAdminClient

InstanceAdminClient

Cloud Spanner Instance Admin API

The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases.

Each instance has a "configuration", which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability.

Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.

Constructor

new InstanceAdminClient(optionsopt, gaxInstanceopt)

Construct an instance of InstanceAdminClient.

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

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

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

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

(async) checkCreateInstanceConfigProgress(name) → {Promise}

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

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.

(async) checkCreateInstancePartitionProgress(name) → {Promise}

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

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.

(async) checkCreateInstanceProgress(name) → {Promise}

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

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.

(async) checkUpdateInstanceConfigProgress(name) → {Promise}

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

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.

(async) checkUpdateInstancePartitionProgress(name) → {Promise}

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

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.

(async) checkUpdateInstanceProgress(name) → {Promise}

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

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.

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.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

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.

instanceConfigPath(project, instance_config) → {string}

Return a fully-qualified instanceConfig resource name string.

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

Resource name string.

instancePartitionPath(project, instance, instance_partition) → {string}

Return a fully-qualified instancePartition resource name string.

Parameters:
Name Type Description
project string
instance string
instance_partition string
Returns:
Type Description
string

Resource name string.

instancePath(project, instance) → {string}

Return a fully-qualified instance resource name string.

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

Resource name string.

listInstanceConfigOperationsAsync(request, optionsopt) → {Object}

Equivalent to listInstanceConfigOperations, 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 project of the instance config operations. Values are of the form projects/<project>.
filter string

An expression that filters the list of returned operations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive.

The following fields in the Operation are eligible for filtering:

* `name` - The name of the long-running operation
* `done` - False if the operation is in progress, else true.
* `metadata.@type` - the type of metadata. For example, the type string
   for
   CreateInstanceConfigMetadata
   is
   `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`.
* `metadata.<field_name>` - any field in metadata.value.
   `metadata.@type` must be specified first, if filtering on metadata
   fields.
* `error` - Error associated with the long-running operation.
* `response.@type` - the type of response.
* `response.<field_name>` - any field in response.value.

You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly.

Here are a few examples:

* `done:true` - The operation is complete.
* `(metadata.@type=` \
  `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata)
  AND` \
  `(metadata.instance_config.name:custom-config) AND` \
  `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \
  `(error:*)` - Return operations where:
  * The operation's metadata type is
  CreateInstanceConfigMetadata.
  * The instance config name contains "custom-config".
  * The operation started before 2021-03-28T14:50:00Z.
  * The operation resulted in an error.
pageSize number

Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListInstanceConfigOperationsResponse to the same parent and with the same filter.
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 Operation. 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.

listInstanceConfigOperationsStream(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 project of the instance config operations. Values are of the form projects/<project>.
filter string

An expression that filters the list of returned operations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive.

The following fields in the Operation are eligible for filtering:

* `name` - The name of the long-running operation
* `done` - False if the operation is in progress, else true.
* `metadata.@type` - the type of metadata. For example, the type string
   for
   CreateInstanceConfigMetadata
   is
   `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`.
* `metadata.<field_name>` - any field in metadata.value.
   `metadata.@type` must be specified first, if filtering on metadata
   fields.
* `error` - Error associated with the long-running operation.
* `response.@type` - the type of response.
* `response.<field_name>` - any field in response.value.

You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly.

Here are a few examples:

* `done:true` - The operation is complete.
* `(metadata.@type=` \
  `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata)
  AND` \
  `(metadata.instance_config.name:custom-config) AND` \
  `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \
  `(error:*)` - Return operations where:
  * The operation's metadata type is
  CreateInstanceConfigMetadata.
  * The instance config name contains "custom-config".
  * The operation started before 2021-03-28T14:50:00Z.
  * The operation resulted in an error.
pageSize number

Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListInstanceConfigOperationsResponse to the same parent and with the same filter.
options object <optional>

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

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

listInstanceConfigsAsync(request, optionsopt) → {Object}

Equivalent to listInstanceConfigs, 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 name of the project for which a list of supported instance configurations is requested. Values are of the form projects/<project>.
pageSize number

Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListInstanceConfigsResponse.
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 InstanceConfig. 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.

listInstanceConfigsStream(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 name of the project for which a list of supported instance configurations is requested. Values are of the form projects/<project>.
pageSize number

Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListInstanceConfigsResponse.
options object <optional>

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

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

listInstancePartitionOperationsAsync(request, optionsopt) → {Object}

Equivalent to listInstancePartitionOperations, 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 Attributes Description
parent string

Required. The parent instance of the instance partition operations. Values are of the form projects/<project>/instances/<instance>.
filter string <optional>

Optional. An expression that filters the list of returned operations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive.

The following fields in the Operation are eligible for filtering:

* `name` - The name of the long-running operation
* `done` - False if the operation is in progress, else true.
* `metadata.@type` - the type of metadata. For example, the type string
   for
   CreateInstancePartitionMetadata
   is
   `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata`.
* `metadata.<field_name>` - any field in metadata.value.
   `metadata.@type` must be specified first, if filtering on metadata
   fields.
* `error` - Error associated with the long-running operation.
* `response.@type` - the type of response.
* `response.<field_name>` - any field in response.value.

You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly.

Here are a few examples:

* `done:true` - The operation is complete.
* `(metadata.@type=` \
  `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata)
  AND` \
  `(metadata.instance_partition.name:custom-instance-partition) AND` \
  `(metadata.start_time < \"2021-03-28T14:50:00Z\") AND` \
  `(error:*)` - Return operations where:
  * The operation's metadata type is
  CreateInstancePartitionMetadata.
  * The instance partition name contains "custom-instance-partition".
  * The operation started before 2021-03-28T14:50:00Z.
  * The operation resulted in an error.
pageSize number <optional>

Optional. Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string <optional>

Optional. If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same parent and with the same filter.
instancePartitionDeadline google.protobuf.Timestamp <optional>

Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionOperationsResponse.
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 Operation. 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.

listInstancePartitionOperationsStream(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 Attributes Description
parent string

Required. The parent instance of the instance partition operations. Values are of the form projects/<project>/instances/<instance>.
filter string <optional>

Optional. An expression that filters the list of returned operations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive.

The following fields in the Operation are eligible for filtering:

* `name` - The name of the long-running operation
* `done` - False if the operation is in progress, else true.
* `metadata.@type` - the type of metadata. For example, the type string
   for
   CreateInstancePartitionMetadata
   is
   `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata`.
* `metadata.<field_name>` - any field in metadata.value.
   `metadata.@type` must be specified first, if filtering on metadata
   fields.
* `error` - Error associated with the long-running operation.
* `response.@type` - the type of response.
* `response.<field_name>` - any field in response.value.

You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly.

Here are a few examples:

* `done:true` - The operation is complete.
* `(metadata.@type=` \
  `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata)
  AND` \
  `(metadata.instance_partition.name:custom-instance-partition) AND` \
  `(metadata.start_time < \"2021-03-28T14:50:00Z\") AND` \
  `(error:*)` - Return operations where:
  * The operation's metadata type is
  CreateInstancePartitionMetadata.
  * The instance partition name contains "custom-instance-partition".
  * The operation started before 2021-03-28T14:50:00Z.
  * The operation resulted in an error.
pageSize number <optional>

Optional. Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string <optional>

Optional. If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same parent and with the same filter.
instancePartitionDeadline google.protobuf.Timestamp <optional>

Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionOperationsResponse.
options object <optional>

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

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

listInstancePartitionsAsync(request, optionsopt) → {Object}

Equivalent to listInstancePartitions, 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 Attributes Description
parent string

Required. The instance whose instance partitions should be listed. Values are of the form projects/<project>/instances/<instance>.
pageSize number

Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionsResponse.
instancePartitionDeadline google.protobuf.Timestamp <optional>

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.
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 InstancePartition. 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.

listInstancePartitionsStream(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 Attributes Description
parent string

Required. The instance whose instance partitions should be listed. Values are of the form projects/<project>/instances/<instance>.
pageSize number

Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionsResponse.
instancePartitionDeadline google.protobuf.Timestamp <optional>

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.
options object <optional>

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

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

listInstancesAsync(request, optionsopt) → {Object}

Equivalent to listInstances, 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 name of the project for which a list of instances is requested. Values are of the form projects/<project>.
pageSize number

Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.
filter string

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

* `name`
* `display_name`
* `labels.key` where key is the name of a label

Some examples of using filters are:

* `name:*` --> The instance has a name.
* `name:Howl` --> The instance's name contains the string "howl".
* `name:HOWL` --> Equivalent to above.
* `NAME:howl` --> Equivalent to above.
* `labels.env:*` --> The instance has the label "env".
* `labels.env:dev` --> The instance has the label "env" and the value of
                     the label contains the string "dev".
* `name:howl labels.env:dev` --> The instance's name contains "howl" and
                               it has the label "env" with its value
                               containing "dev".
instanceDeadline google.protobuf.Timestamp

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.
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 Instance. 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.

listInstancesStream(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 name of the project for which a list of instances is requested. Values are of the form projects/<project>.
pageSize number

Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.
filter string

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

* `name`
* `display_name`
* `labels.key` where key is the name of a label

Some examples of using filters are:

* `name:*` --> The instance has a name.
* `name:Howl` --> The instance's name contains the string "howl".
* `name:HOWL` --> Equivalent to above.
* `NAME:howl` --> Equivalent to above.
* `labels.env:*` --> The instance has the label "env".
* `labels.env:dev` --> The instance has the label "env" and the value of
                     the label contains the string "dev".
* `name:howl labels.env:dev` --> The instance's name contains "howl" and
                               it has the label "env" with its value
                               containing "dev".
instanceDeadline google.protobuf.Timestamp

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.
options object <optional>

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

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

matchInstanceConfigFromInstanceConfigName(instanceConfigName) → {string}

Parse the instance_config from InstanceConfig resource.

Parameters:
Name Type Description
instanceConfigName string

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

A string representing the instance_config.

matchInstanceFromInstanceName(instanceName) → {string}

Parse the instance from Instance resource.

Parameters:
Name Type Description
instanceName string

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

A string representing the instance.

matchInstanceFromInstancePartitionName(instancePartitionName) → {string}

Parse the instance from InstancePartition resource.

Parameters:
Name Type Description
instancePartitionName string

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

A string representing the instance.

matchInstancePartitionFromInstancePartitionName(instancePartitionName) → {string}

Parse the instance_partition from InstancePartition resource.

Parameters:
Name Type Description
instancePartitionName string

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

A string representing the instance_partition.

matchProjectFromInstanceConfigName(instanceConfigName) → {string}

Parse the project from InstanceConfig resource.

Parameters:
Name Type Description
instanceConfigName string

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

A string representing the project.

matchProjectFromInstanceName(instanceName) → {string}

Parse the project from Instance resource.

Parameters:
Name Type Description
instanceName string

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

A string representing the project.

matchProjectFromInstancePartitionName(instancePartitionName) → {string}

Parse the project from InstancePartition resource.

Parameters:
Name Type Description
instancePartitionName string

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

A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:
Name Type Description
projectName string

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

A string representing the project.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

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

Resource name string.