ApiHubPluginClient - Documentation

Constructor

new ApiHubPluginClient(optionsopt, gaxInstanceopt)

Construct an instance of ApiHubPluginClient.

Parameters:

Name Type Attributes Description

options

object

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

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

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

The port on which to connect to the remote host.

projectId

string

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

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

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 ApiHubPluginClient({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

apiHubInstancePath(project, location, api_hub_instance) → {string}

Return a fully-qualified apiHubInstance resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`api_hub_instance`	string

Returns:

Type	Description
string	Resource name string.

apiOperationPath(project, location, api, version, operation) → {string}

Return a fully-qualified apiOperation resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`api`	string
`version`	string
`operation`	string

Returns:

Type	Description
string	Resource name string.

apiPath(project, location, api) → {string}

Return a fully-qualified api resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`api`	string

Returns:

Type	Description
string	Resource name string.

attributePath(project, location, attribute) → {string}

Return a fully-qualified attribute resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`attribute`	string

Returns:

Type	Description
string	Resource name string.

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 parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

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) checkCreatePluginInstanceProgress(name) → {Promise}

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

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 of the plugin instance resource.
   *  Format: `projects/{project}/locations/{location}/plugins/{plugin}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The ID to use for the plugin instance, which will become the
   *  final component of the plugin instance's resource name. This field is
   *  optional.
   *  * If provided, the same will be used. The service will throw an error if
   *  the specified id is already used by another plugin instance in the plugin
   *  resource.
   *  * If not provided, a system generated id will be used.
   *  This value should be 4-63 characters, and valid characters
   *  are /[a-z][A-Z][0-9]-_/.
   */
  // const pluginInstanceId = 'abc123'
  /**
   *  Required. The plugin instance to create.
   */
  // const pluginInstance = {}

  // Imports the Apihub library
  const {ApiHubPluginClient} = require('@google-cloud/apihub').v1;

  // Instantiates a client
  const apihubClient = new ApiHubPluginClient();

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

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

  callCreatePluginInstance();

(async) checkDeletePluginInstanceProgress(name) → {Promise}

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

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 name of the plugin instance to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`.
   */
  // const name = 'abc123'

  // Imports the Apihub library
  const {ApiHubPluginClient} = require('@google-cloud/apihub').v1;

  // Instantiates a client
  const apihubClient = new ApiHubPluginClient();

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

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

  callDeletePluginInstance();

(async) checkDeletePluginProgress(name) → {Promise}

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

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 name of the Plugin resource to delete.
   *  Format: `projects/{project}/locations/{location}/plugins/{plugin}`
   */
  // const name = 'abc123'

  // Imports the Apihub library
  const {ApiHubPluginClient} = require('@google-cloud/apihub').v1;

  // Instantiates a client
  const apihubClient = new ApiHubPluginClient();

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

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

  callDeletePlugin();

(async) checkDisablePluginInstanceActionProgress(name) → {Promise}

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

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 name of the plugin instance to disable.
   *  Format:
   *  `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
   */
  // const name = 'abc123'
  /**
   *  Required. The action id to disable.
   */
  // const actionId = 'abc123'

  // Imports the Apihub library
  const {ApiHubPluginClient} = require('@google-cloud/apihub').v1;

  // Instantiates a client
  const apihubClient = new ApiHubPluginClient();

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

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

  callDisablePluginInstanceAction();

(async) checkEnablePluginInstanceActionProgress(name) → {Promise}

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

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 name of the plugin instance to enable.
   *  Format:
   *  `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
   */
  // const name = 'abc123'
  /**
   *  Required. The action id to enable.
   */
  // const actionId = 'abc123'

  // Imports the Apihub library
  const {ApiHubPluginClient} = require('@google-cloud/apihub').v1;

  // Instantiates a client
  const apihubClient = new ApiHubPluginClient();

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

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

  callEnablePluginInstanceAction();

(async) checkExecutePluginInstanceActionProgress(name) → {Promise}

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

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 name of the plugin instance to execute.
   *  Format:
   *  `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
   */
  // const name = 'abc123'
  /**
   *  Required. The execution details for the action to execute.
   */
  // const actionExecutionDetail = {}

  // Imports the Apihub library
  const {ApiHubPluginClient} = require('@google-cloud/apihub').v1;

  // Instantiates a client
  const apihubClient = new ApiHubPluginClient();

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

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

  callExecutePluginInstanceAction();

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.

curationPath(project, location, curation) → {string}

Return a fully-qualified curation resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`curation`	string

Returns:

Type	Description
string	Resource name string.

definitionPath(project, location, api, version, definition) → {string}

Return a fully-qualified definition resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`api`	string
`version`	string
`definition`	string

Returns:

Type	Description
string	Resource name string.

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 parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

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: ''});
```

dependencyPath(project, location, dependency) → {string}

Return a fully-qualified dependency resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`dependency`	string

Returns:

Type	Description
string	Resource name string.

deploymentPath(project, location, deployment) → {string}

Return a fully-qualified deployment resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`deployment`	string

Returns:

Type	Description
string	Resource name string.

discoveredApiObservationPath(project, location, discovered_api_observation) → {string}

Return a fully-qualified discoveredApiObservation resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`discovered_api_observation`	string

Returns:

Type	Description
string	Resource name string.

discoveredApiOperationPath(project, location, discovered_api_observation, discovered_api_operation) → {string}

Return a fully-qualified discoveredApiOperation resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`discovered_api_observation`	string
`discovered_api_operation`	string

Returns:

Type	Description
string	Resource name string.

externalApiPath(project, location, external_api) → {string}

Return a fully-qualified externalApi resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`external_api`	string

Returns:

Type	Description
string	Resource name string.

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

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 parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

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.

hostProjectRegistrationPath(project, location, host_project_registration) → {string}

Return a fully-qualified hostProjectRegistration resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`host_project_registration`	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

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 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)
```

listPluginInstancesAsync(request, optionsopt) → {Object}

Equivalent to listPluginInstances, 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 resource where this plugin will be created. Format: `projects/{project}/locations/{location}/plugins/{plugin}`. To list plugin instances for multiple plugins, use the - character instead of the plugin ID.
`filter`	string	<optional>	Optional. An expression that filters the list of plugin instances. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `PluginInstances` are eligible for filtering: * `state` - The state of the Plugin Instance. Allowed comparison operators: `=`. A filter function is also supported in the filter string. The filter function is `id(name)`. The `id(name)` function returns the id of the resource name. For example, `id(name) = \"plugin-instance-1\"` is equivalent to `name = \"projects/test-project-id/locations/test-location-id/plugins/plugin-1/instances/plugin-instance-1\"` provided the parent is `projects/test-project-id/locations/test-location-id/plugins/plugin-1`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `state = ENABLED` - The plugin instance is in enabled state.
`pageSize`	number	<optional>	Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
`pageToken`	string	<optional>	Optional. A page token, received from a previous `ListPluginInstances` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluginInstances` must match the call that provided the page token.

options

object

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 PluginInstance. 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 where this plugin will be created.
   *  Format: `projects/{project}/locations/{location}/plugins/{plugin}`.
   *  To list plugin instances for multiple plugins,
   *  use the - character instead of the plugin ID.
   */
  // const parent = 'abc123'
  /**
   *  Optional. An expression that filters the list of plugin instances.
   *  A filter expression consists of a field name, a comparison
   *  operator, and a value for filtering. The value must be a string. The
   *  comparison operator must be one of: `<`, `>` or
   *  `=`. Filters are not case sensitive.
   *  The following fields in the `PluginInstances` are eligible for filtering:
   *    * `state` - The state of the Plugin Instance. Allowed
   *    comparison operators: `=`.
   *  A filter function is also supported in the filter string. The filter
   *  function is `id(name)`. The `id(name)` function returns the id of the
   *  resource name. For example, `id(name) = \"plugin-instance-1\"` is
   *  equivalent to `name =
   *  \"projects/test-project-id/locations/test-location-id/plugins/plugin-1/instances/plugin-instance-1\"`
   *  provided the parent is
   *  `projects/test-project-id/locations/test-location-id/plugins/plugin-1`.
   *  Expressions are combined with either `AND` logic operator or `OR` logical
   *  operator but not both of them together i.e. only one of the `AND` or `OR`
   *  operator can be used throughout the filter string and both the operators
   *  cannot be used together. No other logical operators are
   *  supported. At most three filter fields are allowed in the filter
   *  string and if provided more than that then `INVALID_ARGUMENT` error is
   *  returned by the API.
   *  Here are a few examples:
   *    * `state = ENABLED` - The plugin instance is in enabled state.
   */
  // const filter = 'abc123'
  /**
   *  Optional. The maximum number of hub plugins to return. The service may
   *  return fewer than this value. If unspecified, at most 50 hub plugins will
   *  be returned. The maximum value is 1000; values above 1000 will be coerced
   *  to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListPluginInstances`
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListPluginInstances`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Apihub library
  const {ApiHubPluginClient} = require('@google-cloud/apihub').v1;

  // Instantiates a client
  const apihubClient = new ApiHubPluginClient();

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

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

  callListPluginInstances();

listPluginInstancesStream(request, optionsopt) → {Stream}

Equivalent to listPluginInstances, 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 resource where this plugin will be created. Format: `projects/{project}/locations/{location}/plugins/{plugin}`. To list plugin instances for multiple plugins, use the - character instead of the plugin ID.
`filter`	string	<optional>	Optional. An expression that filters the list of plugin instances. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `PluginInstances` are eligible for filtering: * `state` - The state of the Plugin Instance. Allowed comparison operators: `=`. A filter function is also supported in the filter string. The filter function is `id(name)`. The `id(name)` function returns the id of the resource name. For example, `id(name) = \"plugin-instance-1\"` is equivalent to `name = \"projects/test-project-id/locations/test-location-id/plugins/plugin-1/instances/plugin-instance-1\"` provided the parent is `projects/test-project-id/locations/test-location-id/plugins/plugin-1`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `state = ENABLED` - The plugin instance is in enabled state.
`pageSize`	number	<optional>	Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
`pageToken`	string	<optional>	Optional. A page token, received from a previous `ListPluginInstances` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluginInstances` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

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

listPluginsAsync(request, optionsopt) → {Object}

Equivalent to listPlugins, 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 resource where this plugin will be created. Format: `projects/{project}/locations/{location}`.
`filter`	string	<optional>	Optional. An expression that filters the list of plugins. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Plugins` are eligible for filtering: * `plugin_category` - The category of the Plugin. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `plugin_category = ON_RAMP` - The plugin is of category on ramp.
`pageSize`	number	<optional>	Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
`pageToken`	string	<optional>	Optional. A page token, received from a previous `ListPlugins` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListPlugins` must match the call that provided the page token.

options

object

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 Plugin. 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 where this plugin will be created.
   *  Format: `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. An expression that filters the list of plugins.
   *  A filter expression consists of a field name, a comparison
   *  operator, and a value for filtering. The value must be a string. The
   *  comparison operator must be one of: `<`, `>` or
   *  `=`. Filters are not case sensitive.
   *  The following fields in the `Plugins` are eligible for filtering:
   *    * `plugin_category` - The category of the Plugin. Allowed
   *    comparison operators: `=`.
   *  Expressions are combined with either `AND` logic operator or `OR` logical
   *  operator but not both of them together i.e. only one of the `AND` or `OR`
   *  operator can be used throughout the filter string and both the operators
   *  cannot be used together. No other logical operators are
   *  supported. At most three filter fields are allowed in the filter
   *  string and if provided more than that then `INVALID_ARGUMENT` error is
   *  returned by the API.
   *  Here are a few examples:
   *    * `plugin_category = ON_RAMP` - The plugin is of category
   *    on ramp.
   */
  // const filter = 'abc123'
  /**
   *  Optional. The maximum number of hub plugins to return. The service may
   *  return fewer than this value. If unspecified, at most 50 hub plugins will
   *  be returned. The maximum value is 1000; values above 1000 will be coerced
   *  to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListPlugins` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters (except page_size) provided to
   *  `ListPlugins` must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Apihub library
  const {ApiHubPluginClient} = require('@google-cloud/apihub').v1;

  // Instantiates a client
  const apihubClient = new ApiHubPluginClient();

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

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

  callListPlugins();

listPluginsStream(request, optionsopt) → {Stream}

Equivalent to listPlugins, 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 resource where this plugin will be created. Format: `projects/{project}/locations/{location}`.
`filter`	string	<optional>	Optional. An expression that filters the list of plugins. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Plugins` are eligible for filtering: * `plugin_category` - The category of the Plugin. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `plugin_category = ON_RAMP` - The plugin is of category on ramp.
`pageSize`	number	<optional>	Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
`pageToken`	string	<optional>	Optional. A page token, received from a previous `ListPlugins` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListPlugins` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Plugin 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 `listPluginsAsync()` 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.

matchApiFromApiName(apiName) → {string}

Parse the api from Api resource.

Parameters:

Name	Type	Description
`apiName`	string	A fully-qualified path representing Api resource.

Returns:

Type	Description
string	A string representing the api.

matchApiFromApiOperationName(apiOperationName) → {string}

Parse the api from ApiOperation resource.

Parameters:

Name	Type	Description
`apiOperationName`	string	A fully-qualified path representing ApiOperation resource.

Returns:

Type	Description
string	A string representing the api.

matchApiFromDefinitionName(definitionName) → {string}

Parse the api from Definition resource.

Parameters:

Name	Type	Description
`definitionName`	string	A fully-qualified path representing Definition resource.

Returns:

Type	Description
string	A string representing the api.

matchApiFromSpecName(specName) → {string}

Parse the api from Spec resource.

Parameters:

Name	Type	Description
`specName`	string	A fully-qualified path representing Spec resource.

Returns:

Type	Description
string	A string representing the api.

matchApiFromVersionName(versionName) → {string}

Parse the api from Version resource.

Parameters:

Name	Type	Description
`versionName`	string	A fully-qualified path representing Version resource.

Returns:

Type	Description
string	A string representing the api.

matchApiHubInstanceFromApiHubInstanceName(apiHubInstanceName) → {string}

Parse the api_hub_instance from ApiHubInstance resource.

Parameters:

Name	Type	Description
`apiHubInstanceName`	string	A fully-qualified path representing ApiHubInstance resource.

Returns:

Type	Description
string	A string representing the api_hub_instance.

matchAttributeFromAttributeName(attributeName) → {string}

Parse the attribute from Attribute resource.

Parameters:

Name	Type	Description
`attributeName`	string	A fully-qualified path representing Attribute resource.

Returns:

Type	Description
string	A string representing the attribute.

matchCurationFromCurationName(curationName) → {string}

Parse the curation from Curation resource.

Parameters:

Name	Type	Description
`curationName`	string	A fully-qualified path representing Curation resource.

Returns:

Type	Description
string	A string representing the curation.

matchDefinitionFromDefinitionName(definitionName) → {string}

Parse the definition from Definition resource.

Parameters:

Name	Type	Description
`definitionName`	string	A fully-qualified path representing Definition resource.

Returns:

Type	Description
string	A string representing the definition.

matchDependencyFromDependencyName(dependencyName) → {string}

Parse the dependency from Dependency resource.

Parameters:

Name	Type	Description
`dependencyName`	string	A fully-qualified path representing Dependency resource.

Returns:

Type	Description
string	A string representing the dependency.

matchDeploymentFromDeploymentName(deploymentName) → {string}

Parse the deployment from Deployment resource.

Parameters:

Name	Type	Description
`deploymentName`	string	A fully-qualified path representing Deployment resource.

Returns:

Type	Description
string	A string representing the deployment.

matchDiscoveredApiObservationFromDiscoveredApiObservationName(discoveredApiObservationName) → {string}

Parse the discovered_api_observation from DiscoveredApiObservation resource.

Parameters:

Name	Type	Description
`discoveredApiObservationName`	string	A fully-qualified path representing DiscoveredApiObservation resource.

Returns:

Type	Description
string	A string representing the discovered_api_observation.

matchDiscoveredApiObservationFromDiscoveredApiOperationName(discoveredApiOperationName) → {string}

Parse the discovered_api_observation from DiscoveredApiOperation resource.

Parameters:

Name	Type	Description
`discoveredApiOperationName`	string	A fully-qualified path representing DiscoveredApiOperation resource.

Returns:

Type	Description
string	A string representing the discovered_api_observation.

matchDiscoveredApiOperationFromDiscoveredApiOperationName(discoveredApiOperationName) → {string}

Parse the discovered_api_operation from DiscoveredApiOperation resource.

Parameters:

Name	Type	Description
`discoveredApiOperationName`	string	A fully-qualified path representing DiscoveredApiOperation resource.

Returns:

Type	Description
string	A string representing the discovered_api_operation.

matchExternalApiFromExternalApiName(externalApiName) → {string}

Parse the external_api from ExternalApi resource.

Parameters:

Name	Type	Description
`externalApiName`	string	A fully-qualified path representing ExternalApi resource.

Returns:

Type	Description
string	A string representing the external_api.

matchHostProjectRegistrationFromHostProjectRegistrationName(hostProjectRegistrationName) → {string}

Parse the host_project_registration from HostProjectRegistration resource.

Parameters:

Name	Type	Description
`hostProjectRegistrationName`	string	A fully-qualified path representing HostProjectRegistration resource.

Returns:

Type	Description
string	A string representing the host_project_registration.

matchInstanceFromPluginInstanceName(pluginInstanceName) → {string}

Parse the instance from PluginInstance resource.

Parameters:

Name	Type	Description
`pluginInstanceName`	string	A fully-qualified path representing PluginInstance resource.

Returns:

Type	Description
string	A string representing the instance.

matchLocationFromApiHubInstanceName(apiHubInstanceName) → {string}

Parse the location from ApiHubInstance resource.

Parameters:

Name	Type	Description
`apiHubInstanceName`	string	A fully-qualified path representing ApiHubInstance resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromApiName(apiName) → {string}

Parse the location from Api resource.

Parameters:

Name	Type	Description
`apiName`	string	A fully-qualified path representing Api resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromApiOperationName(apiOperationName) → {string}

Parse the location from ApiOperation resource.

Parameters:

Name	Type	Description
`apiOperationName`	string	A fully-qualified path representing ApiOperation resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromAttributeName(attributeName) → {string}

Parse the location from Attribute resource.

Parameters:

Name	Type	Description
`attributeName`	string	A fully-qualified path representing Attribute resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromCurationName(curationName) → {string}

Parse the location from Curation resource.

Parameters:

Name	Type	Description
`curationName`	string	A fully-qualified path representing Curation resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromDefinitionName(definitionName) → {string}

Parse the location from Definition resource.

Parameters:

Name	Type	Description
`definitionName`	string	A fully-qualified path representing Definition resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromDependencyName(dependencyName) → {string}

Parse the location from Dependency resource.

Parameters:

Name	Type	Description
`dependencyName`	string	A fully-qualified path representing Dependency resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromDeploymentName(deploymentName) → {string}

Parse the location from Deployment resource.

Parameters:

Name	Type	Description
`deploymentName`	string	A fully-qualified path representing Deployment resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromDiscoveredApiObservationName(discoveredApiObservationName) → {string}

Parse the location from DiscoveredApiObservation resource.

Parameters:

Name	Type	Description
`discoveredApiObservationName`	string	A fully-qualified path representing DiscoveredApiObservation resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromDiscoveredApiOperationName(discoveredApiOperationName) → {string}

Parse the location from DiscoveredApiOperation resource.

Parameters:

Name	Type	Description
`discoveredApiOperationName`	string	A fully-qualified path representing DiscoveredApiOperation resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromExternalApiName(externalApiName) → {string}

Parse the location from ExternalApi resource.

Parameters:

Name	Type	Description
`externalApiName`	string	A fully-qualified path representing ExternalApi resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromHostProjectRegistrationName(hostProjectRegistrationName) → {string}

Parse the location from HostProjectRegistration resource.

Parameters:

Name	Type	Description
`hostProjectRegistrationName`	string	A fully-qualified path representing HostProjectRegistration resource.

Returns:

Type	Description
string	A string representing the location.

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.

matchLocationFromPluginInstanceName(pluginInstanceName) → {string}

Parse the location from PluginInstance resource.

Parameters:

Name	Type	Description
`pluginInstanceName`	string	A fully-qualified path representing PluginInstance resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromPluginName(pluginName) → {string}

Parse the location from Plugin resource.

Parameters:

Name	Type	Description
`pluginName`	string	A fully-qualified path representing Plugin resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromRuntimeProjectAttachmentName(runtimeProjectAttachmentName) → {string}

Parse the location from RuntimeProjectAttachment resource.

Parameters:

Name	Type	Description
`runtimeProjectAttachmentName`	string	A fully-qualified path representing RuntimeProjectAttachment resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromSpecName(specName) → {string}

Parse the location from Spec resource.

Parameters:

Name	Type	Description
`specName`	string	A fully-qualified path representing Spec resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromStyleGuideName(styleGuideName) → {string}

Parse the location from StyleGuide resource.

Parameters:

Name	Type	Description
`styleGuideName`	string	A fully-qualified path representing StyleGuide resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromVersionName(versionName) → {string}

Parse the location from Version resource.

Parameters:

Name	Type	Description
`versionName`	string	A fully-qualified path representing Version resource.

Returns:

Type	Description
string	A string representing the location.

matchOperationFromApiOperationName(apiOperationName) → {string}

Parse the operation from ApiOperation resource.

Parameters:

Name	Type	Description
`apiOperationName`	string	A fully-qualified path representing ApiOperation resource.

Returns:

Type	Description
string	A string representing the operation.

matchPluginFromPluginInstanceName(pluginInstanceName) → {string}

Parse the plugin from PluginInstance resource.

Parameters:

Name	Type	Description
`pluginInstanceName`	string	A fully-qualified path representing PluginInstance resource.

Returns:

Type	Description
string	A string representing the plugin.

matchPluginFromPluginName(pluginName) → {string}

Parse the plugin from Plugin resource.

Parameters:

Name	Type	Description
`pluginName`	string	A fully-qualified path representing Plugin resource.

Returns:

Type	Description
string	A string representing the plugin.

matchPluginFromStyleGuideName(styleGuideName) → {string}

Parse the plugin from StyleGuide resource.

Parameters:

Name	Type	Description
`styleGuideName`	string	A fully-qualified path representing StyleGuide resource.

Returns:

Type	Description
string	A string representing the plugin.

matchProjectFromApiHubInstanceName(apiHubInstanceName) → {string}

Parse the project from ApiHubInstance resource.

Parameters:

Name	Type	Description
`apiHubInstanceName`	string	A fully-qualified path representing ApiHubInstance resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromApiName(apiName) → {string}

Parse the project from Api resource.

Parameters:

Name	Type	Description
`apiName`	string	A fully-qualified path representing Api resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromApiOperationName(apiOperationName) → {string}

Parse the project from ApiOperation resource.

Parameters:

Name	Type	Description
`apiOperationName`	string	A fully-qualified path representing ApiOperation resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromAttributeName(attributeName) → {string}

Parse the project from Attribute resource.

Parameters:

Name	Type	Description
`attributeName`	string	A fully-qualified path representing Attribute resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromCurationName(curationName) → {string}

Parse the project from Curation resource.

Parameters:

Name	Type	Description
`curationName`	string	A fully-qualified path representing Curation resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromDefinitionName(definitionName) → {string}

Parse the project from Definition resource.

Parameters:

Name	Type	Description
`definitionName`	string	A fully-qualified path representing Definition resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromDependencyName(dependencyName) → {string}

Parse the project from Dependency resource.

Parameters:

Name	Type	Description
`dependencyName`	string	A fully-qualified path representing Dependency resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromDeploymentName(deploymentName) → {string}

Parse the project from Deployment resource.

Parameters:

Name	Type	Description
`deploymentName`	string	A fully-qualified path representing Deployment resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromDiscoveredApiObservationName(discoveredApiObservationName) → {string}

Parse the project from DiscoveredApiObservation resource.

Parameters:

Name	Type	Description
`discoveredApiObservationName`	string	A fully-qualified path representing DiscoveredApiObservation resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromDiscoveredApiOperationName(discoveredApiOperationName) → {string}

Parse the project from DiscoveredApiOperation resource.

Parameters:

Name	Type	Description
`discoveredApiOperationName`	string	A fully-qualified path representing DiscoveredApiOperation resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromExternalApiName(externalApiName) → {string}

Parse the project from ExternalApi resource.

Parameters:

Name	Type	Description
`externalApiName`	string	A fully-qualified path representing ExternalApi resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromHostProjectRegistrationName(hostProjectRegistrationName) → {string}

Parse the project from HostProjectRegistration resource.

Parameters:

Name	Type	Description
`hostProjectRegistrationName`	string	A fully-qualified path representing HostProjectRegistration 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.

matchProjectFromPluginInstanceName(pluginInstanceName) → {string}

Parse the project from PluginInstance resource.

Parameters:

Name	Type	Description
`pluginInstanceName`	string	A fully-qualified path representing PluginInstance resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromPluginName(pluginName) → {string}

Parse the project from Plugin resource.

Parameters:

Name	Type	Description
`pluginName`	string	A fully-qualified path representing Plugin 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.

matchProjectFromRuntimeProjectAttachmentName(runtimeProjectAttachmentName) → {string}

Parse the project from RuntimeProjectAttachment resource.

Parameters:

Name	Type	Description
`runtimeProjectAttachmentName`	string	A fully-qualified path representing RuntimeProjectAttachment resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromSpecName(specName) → {string}

Parse the project from Spec resource.

Parameters:

Name	Type	Description
`specName`	string	A fully-qualified path representing Spec resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromStyleGuideName(styleGuideName) → {string}

Parse the project from StyleGuide resource.

Parameters:

Name	Type	Description
`styleGuideName`	string	A fully-qualified path representing StyleGuide resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromVersionName(versionName) → {string}

Parse the project from Version resource.

Parameters:

Name	Type	Description
`versionName`	string	A fully-qualified path representing Version resource.

Returns:

Type	Description
string	A string representing the project.

matchRuntimeProjectAttachmentFromRuntimeProjectAttachmentName(runtimeProjectAttachmentName) → {string}

Parse the runtime_project_attachment from RuntimeProjectAttachment resource.

Parameters:

Name	Type	Description
`runtimeProjectAttachmentName`	string	A fully-qualified path representing RuntimeProjectAttachment resource.

Returns:

Type	Description
string	A string representing the runtime_project_attachment.

matchSpecFromSpecName(specName) → {string}

Parse the spec from Spec resource.

Parameters:

Name	Type	Description
`specName`	string	A fully-qualified path representing Spec resource.

Returns:

Type	Description
string	A string representing the spec.

matchVersionFromApiOperationName(apiOperationName) → {string}

Parse the version from ApiOperation resource.

Parameters:

Name	Type	Description
`apiOperationName`	string	A fully-qualified path representing ApiOperation resource.

Returns:

Type	Description
string	A string representing the version.

matchVersionFromDefinitionName(definitionName) → {string}

Parse the version from Definition resource.

Parameters:

Name	Type	Description
`definitionName`	string	A fully-qualified path representing Definition resource.

Returns:

Type	Description
string	A string representing the version.

matchVersionFromSpecName(specName) → {string}

Parse the version from Spec resource.

Parameters:

Name	Type	Description
`specName`	string	A fully-qualified path representing Spec resource.

Returns:

Type	Description
string	A string representing the version.

matchVersionFromVersionName(versionName) → {string}

Parse the version from Version resource.

Parameters:

Name	Type	Description
`versionName`	string	A fully-qualified path representing Version resource.

Returns:

Type	Description
string	A string representing the version.

pluginInstancePath(project, location, plugin, instance) → {string}

Return a fully-qualified pluginInstance resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`plugin`	string
`instance`	string

Returns:

Type	Description
string	Resource name string.

pluginPath(project, location, plugin) → {string}

Return a fully-qualified plugin resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`plugin`	string

Returns:

Type	Description
string	Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

runtimeProjectAttachmentPath(project, location, runtime_project_attachment) → {string}

Return a fully-qualified runtimeProjectAttachment resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`runtime_project_attachment`	string

Returns:

Type	Description
string	Resource name string.

specPath(project, location, api, version, spec) → {string}

Return a fully-qualified spec resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`api`	string
`version`	string
`spec`	string

Returns:

Type	Description
string	Resource name string.

styleGuidePath(project, location, plugin) → {string}

Return a fully-qualified styleGuide resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`plugin`	string

Returns:

Type	Description
string	Resource name string.

versionPath(project, location, api, version) → {string}

Return a fully-qualified version resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`api`	string
`version`	string

Returns:

Type	Description
string	Resource name string.