ApiHubPluginClient

This service is used for managing plugins inside the API Hub.

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.

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.

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.

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.

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

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.