Constructor
new CloudCatalogClient(optionsopt)
Construct an instance of CloudCatalogClient.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. See the subsequent parameters for more details. Properties
|
Members
(static) apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
(static) port
The port for this API service.
(static) scopes
The scopes needed to make gRPC calls for every method defined in this service.
(static) servicePath
The DNS address for this API service.
Methods
close()
Terminate the GRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
getProjectId(callback)
Return the project ID used by this class.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function |
the callback to be called with the current 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.
listServices(request, optionsopt) → {Promise}
Lists all public cloud services.
Parameters:
| Name | Type | Attributes | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
listServicesStream(request, optionsopt) → {Stream}
Equivalent to listServices, but returns a NodeJS Stream object.
This fetches the paged responses for listServices continuously and invokes the callback registered for 'data' event for each element in the responses.
The returned object has 'end' method when no more elements are required.
autoPaginate option will be ignored.
Parameters:
| Name | Type | Attributes | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
listSkus(request, optionsopt) → {Promise}
Lists all publicly available SKUs for a given cloud service.
Parameters:
| Name | Type | Attributes | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
listSkusStream(request, optionsopt) → {Stream}
Equivalent to listSkus, but returns a NodeJS Stream object.
This fetches the paged responses for listSkus continuously and invokes the callback registered for 'data' event for each element in the responses.
The returned object has 'end' method when no more elements are required.
autoPaginate option will be ignored.
Parameters:
| Name | Type | Attributes | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
matchServiceFromServiceName(serviceName) → {string}
Parse the service from Service resource.
Parameters:
| Name | Type | Description |
|---|---|---|
serviceName |
string |
A fully-qualified path representing Service resource. |
matchServiceFromSkuName(skuName) → {string}
Parse the service from Sku resource.
Parameters:
| Name | Type | Description |
|---|---|---|
skuName |
string |
A fully-qualified path representing Sku resource. |
matchSkuFromSkuName(skuName) → {string}
Parse the sku from Sku resource.
Parameters:
| Name | Type | Description |
|---|---|---|
skuName |
string |
A fully-qualified path representing Sku resource. |
servicePath(service) → {string}
Return a fully-qualified service resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
service |
string |
skuPath(service, sku) → {string}
Return a fully-qualified sku resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
service |
string | |
sku |
string |