Constructor
new DashboardsServiceClient(optionsopt, gaxInstanceopt)
Construct an instance of DashboardsServiceClient.
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
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
alertPolicyPath(project, alert_policy) → {string}
Return a fully-qualified alertPolicy resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
alert_policy |
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. |
dashboardPath(project, dashboard) → {string}
Return a fully-qualified dashboard resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
dashboard |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
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. |
listDashboardsAsync(request, optionsopt) → {Object}
Equivalent to listDashboards
, 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
|
|||||||||||||
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 Dashboard. 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 scope of the dashboards to list. The format is:
* projects/[PROJECT_ID_OR_NUMBER]
*/
// const parent = 'abc123'
/**
* A positive number that is the maximum number of results to return.
* If unspecified, a default of 1000 is used.
*/
// const pageSize = 1234
/**
* If this field is not empty then it must contain the `nextPageToken` value
* returned by a previous call to this method. Using this field causes the
* method to return additional results from the previous method call.
*/
// const pageToken = 'abc123'
// Imports the Dashboard library
const {DashboardsServiceClient} = require('@google-cloud/monitoring-dashboards').v1;
// Instantiates a client
const dashboardClient = new DashboardsServiceClient();
async function callListDashboards() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await dashboardClient.listDashboardsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListDashboards();
listDashboardsStream(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
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing Dashboard 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 |
matchAlertPolicyFromAlertPolicyName(alertPolicyName) → {string}
Parse the alert_policy from AlertPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
alertPolicyName |
string |
A fully-qualified path representing AlertPolicy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the alert_policy. |
matchDashboardFromDashboardName(dashboardName) → {string}
Parse the dashboard from Dashboard resource.
Parameters:
Name | Type | Description |
---|---|---|
dashboardName |
string |
A fully-qualified path representing Dashboard resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the dashboard. |
matchProjectFromAlertPolicyName(alertPolicyName) → {string}
Parse the project from AlertPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
alertPolicyName |
string |
A fully-qualified path representing AlertPolicy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromDashboardName(dashboardName) → {string}
Parse the project from Dashboard resource.
Parameters:
Name | Type | Description |
---|---|---|
dashboardName |
string |
A fully-qualified path representing Dashboard 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. |