Manages metric descriptors, monitored resource descriptors, and time series data. v3
Package
@google-cloud/monitoringConstructors
(constructor)(opts)
constructor(opts?: ClientOptions);Construct an instance of MetricServiceClient.
| Parameter | |
|---|---|
| Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;descriptors
descriptors: Descriptors;innerApiCalls
innerApiCalls: {
[name: string]: Function;
};metricServiceStub
metricServiceStub?: Promise<{
[name: string]: Function;
}>;pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};port
static get port(): number;The port for this API service.
scopes
static get scopes(): string[];The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;The DNS address for this API service.
Methods
close()
close(): Promise<void>;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<void> | {Promise} A promise that resolves when the client is closed. |
createMetricDescriptor(request, options)
createMetricDescriptor(request: protos.google.monitoring.v3.ICreateMetricDescriptorRequest, options?: CallOptions): Promise<[
protos.google.api.IMetricDescriptor,
protos.google.monitoring.v3.ICreateMetricDescriptorRequest | undefined,
{} | undefined
]>;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateMetricDescriptorRequest
|
options |
CallOptions
|
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.api.IMetricDescriptor,
protos.google.monitoring.v3.ICreateMetricDescriptorRequest | undefined,
{} | undefined
]> | |
createMetricDescriptor(request, options, callback)
createMetricDescriptor(request: protos.google.monitoring.v3.ICreateMetricDescriptorRequest, options: CallOptions, callback: Callback<protos.google.api.IMetricDescriptor, protos.google.monitoring.v3.ICreateMetricDescriptorRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateMetricDescriptorRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.api.IMetricDescriptor, protos.google.monitoring.v3.ICreateMetricDescriptorRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void | |
createMetricDescriptor(request, callback)
createMetricDescriptor(request: protos.google.monitoring.v3.ICreateMetricDescriptorRequest, callback: Callback<protos.google.api.IMetricDescriptor, protos.google.monitoring.v3.ICreateMetricDescriptorRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateMetricDescriptorRequest
|
callback |
Callback<protos.google.api.IMetricDescriptor, protos.google.monitoring.v3.ICreateMetricDescriptorRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void | |
createTimeSeries(request, options)
createTimeSeries(request: protos.google.monitoring.v3.ICreateTimeSeriesRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.monitoring.v3.ICreateTimeSeriesRequest | undefined,
{} | undefined
]>;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateTimeSeriesRequest
|
options |
CallOptions
|
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
protos.google.monitoring.v3.ICreateTimeSeriesRequest | undefined,
{} | undefined
]> | |
createTimeSeries(request, options, callback)
createTimeSeries(request: protos.google.monitoring.v3.ICreateTimeSeriesRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.ICreateTimeSeriesRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateTimeSeriesRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.ICreateTimeSeriesRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void | |
createTimeSeries(request, callback)
createTimeSeries(request: protos.google.monitoring.v3.ICreateTimeSeriesRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.ICreateTimeSeriesRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateTimeSeriesRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.ICreateTimeSeriesRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void | |
deleteMetricDescriptor(request, options)
deleteMetricDescriptor(request: protos.google.monitoring.v3.IDeleteMetricDescriptorRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.monitoring.v3.IDeleteMetricDescriptorRequest | undefined,
{} | undefined
]>;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteMetricDescriptorRequest
|
options |
CallOptions
|
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
protos.google.monitoring.v3.IDeleteMetricDescriptorRequest | undefined,
{} | undefined
]> | |
deleteMetricDescriptor(request, options, callback)
deleteMetricDescriptor(request: protos.google.monitoring.v3.IDeleteMetricDescriptorRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.IDeleteMetricDescriptorRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteMetricDescriptorRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.IDeleteMetricDescriptorRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void | |
deleteMetricDescriptor(request, callback)
deleteMetricDescriptor(request: protos.google.monitoring.v3.IDeleteMetricDescriptorRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.IDeleteMetricDescriptorRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteMetricDescriptorRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.IDeleteMetricDescriptorRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void | |
folderAlertPolicyConditionPath(folder, alertPolicy, condition)
folderAlertPolicyConditionPath(folder: string, alertPolicy: string, condition: string): string;Return a fully-qualified folderAlertPolicyCondition resource name string.
| Parameters | |
|---|---|
| Name | Description |
folder |
string
|
alertPolicy |
string
|
condition |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
folderAlertPolicyPath(folder, alertPolicy)
folderAlertPolicyPath(folder: string, alertPolicy: string): string;Return a fully-qualified folderAlertPolicy resource name string.
| Parameters | |
|---|---|
| Name | Description |
folder |
string
|
alertPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
folderChannelDescriptorPath(folder, channelDescriptor)
folderChannelDescriptorPath(folder: string, channelDescriptor: string): string;Return a fully-qualified folderChannelDescriptor resource name string.
| Parameters | |
|---|---|
| Name | Description |
folder |
string
|
channelDescriptor |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
folderGroupPath(folder, group)
folderGroupPath(folder: string, group: string): string;Return a fully-qualified folderGroup resource name string.
| Parameters | |
|---|---|
| Name | Description |
folder |
string
|
group |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
folderMetricDescriptorPath(folder, metricDescriptor)
folderMetricDescriptorPath(folder: string, metricDescriptor: string): string;Return a fully-qualified folderMetricDescriptor resource name string.
| Parameters | |
|---|---|
| Name | Description |
folder |
string
|
metricDescriptor |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
folderMonitoredResourceDescriptorPath(folder, monitoredResourceDescriptor)
folderMonitoredResourceDescriptorPath(folder: string, monitoredResourceDescriptor: string): string;Return a fully-qualified folderMonitoredResourceDescriptor resource name string.
| Parameters | |
|---|---|
| Name | Description |
folder |
string
|
monitoredResourceDescriptor |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
folderNotificationChannelPath(folder, notificationChannel)
folderNotificationChannelPath(folder: string, notificationChannel: string): string;Return a fully-qualified folderNotificationChannel resource name string.
| Parameters | |
|---|---|
| Name | Description |
folder |
string
|
notificationChannel |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
folderServicePath(folder, service)
folderServicePath(folder: string, service: string): string;Return a fully-qualified folderService resource name string.
| Parameters | |
|---|---|
| Name | Description |
folder |
string
|
service |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
folderServiceServiceLevelObjectivePath(folder, service, serviceLevelObjective)
folderServiceServiceLevelObjectivePath(folder: string, service: string, serviceLevelObjective: string): string;Return a fully-qualified folderServiceServiceLevelObjective resource name string.
| Parameters | |
|---|---|
| Name | Description |
folder |
string
|
service |
string
|
serviceLevelObjective |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
folderUptimeCheckConfigPath(folder, uptimeCheckConfig)
folderUptimeCheckConfigPath(folder: string, uptimeCheckConfig: string): string;Return a fully-qualified folderUptimeCheckConfig resource name string.
| Parameters | |
|---|---|
| Name | Description |
folder |
string
|
uptimeCheckConfig |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
getMetricDescriptor(request, options)
getMetricDescriptor(request: protos.google.monitoring.v3.IGetMetricDescriptorRequest, options?: CallOptions): Promise<[
protos.google.api.IMetricDescriptor,
protos.google.monitoring.v3.IGetMetricDescriptorRequest | undefined,
{} | undefined
]>;| Parameters | |
|---|---|
| Name | Description |
request |
IGetMetricDescriptorRequest
|
options |
CallOptions
|
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.api.IMetricDescriptor,
protos.google.monitoring.v3.IGetMetricDescriptorRequest | undefined,
{} | undefined
]> | |
getMetricDescriptor(request, options, callback)
getMetricDescriptor(request: protos.google.monitoring.v3.IGetMetricDescriptorRequest, options: CallOptions, callback: Callback<protos.google.api.IMetricDescriptor, protos.google.monitoring.v3.IGetMetricDescriptorRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetMetricDescriptorRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.api.IMetricDescriptor, protos.google.monitoring.v3.IGetMetricDescriptorRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void | |
getMetricDescriptor(request, callback)
getMetricDescriptor(request: protos.google.monitoring.v3.IGetMetricDescriptorRequest, callback: Callback<protos.google.api.IMetricDescriptor, protos.google.monitoring.v3.IGetMetricDescriptorRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetMetricDescriptorRequest
|
callback |
Callback<protos.google.api.IMetricDescriptor, protos.google.monitoring.v3.IGetMetricDescriptorRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void | |
getMonitoredResourceDescriptor(request, options)
getMonitoredResourceDescriptor(request: protos.google.monitoring.v3.IGetMonitoredResourceDescriptorRequest, options?: CallOptions): Promise<[
protos.google.api.IMonitoredResourceDescriptor,
(protos.google.monitoring.v3.IGetMonitoredResourceDescriptorRequest | undefined),
{} | undefined
]>;| Parameters | |
|---|---|
| Name | Description |
request |
IGetMonitoredResourceDescriptorRequest
|
options |
CallOptions
|
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.api.IMonitoredResourceDescriptor,
(protos.google.monitoring.v3.IGetMonitoredResourceDescriptorRequest | undefined),
{} | undefined
]> | |
getMonitoredResourceDescriptor(request, options, callback)
getMonitoredResourceDescriptor(request: protos.google.monitoring.v3.IGetMonitoredResourceDescriptorRequest, options: CallOptions, callback: Callback<protos.google.api.IMonitoredResourceDescriptor, protos.google.monitoring.v3.IGetMonitoredResourceDescriptorRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetMonitoredResourceDescriptorRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.api.IMonitoredResourceDescriptor, protos.google.monitoring.v3.IGetMonitoredResourceDescriptorRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void | |
getMonitoredResourceDescriptor(request, callback)
getMonitoredResourceDescriptor(request: protos.google.monitoring.v3.IGetMonitoredResourceDescriptorRequest, callback: Callback<protos.google.api.IMonitoredResourceDescriptor, protos.google.monitoring.v3.IGetMonitoredResourceDescriptorRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetMonitoredResourceDescriptorRequest
|
callback |
Callback<protos.google.api.IMonitoredResourceDescriptor, protos.google.monitoring.v3.IGetMonitoredResourceDescriptorRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void | |
getProjectId()
getProjectId(): Promise<string>;| Returns | |
|---|---|
| Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;| Parameter | |
|---|---|
| Name | Description |
callback |
Callback<string, undefined, undefined>
|
| Returns | |
|---|---|
| Type | Description |
void | |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;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<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub. |
listMetricDescriptors(request, options)
listMetricDescriptors(request: protos.google.monitoring.v3.IListMetricDescriptorsRequest, options?: CallOptions): Promise<[
protos.google.api.IMetricDescriptor[],
protos.google.monitoring.v3.IListMetricDescriptorsRequest | null,
protos.google.monitoring.v3.IListMetricDescriptorsResponse
]>;| Parameters | |
|---|---|
| Name | Description |
request |
IListMetricDescriptorsRequest
|
options |
CallOptions
|
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.api.IMetricDescriptor[],
protos.google.monitoring.v3.IListMetricDescriptorsRequest | null,
protos.google.monitoring.v3.IListMetricDescriptorsResponse
]> | |
listMetricDescriptors(request, options, callback)
listMetricDescriptors(request: protos.google.monitoring.v3.IListMetricDescriptorsRequest, options: CallOptions, callback: PaginationCallback<protos.google.monitoring.v3.IListMetricDescriptorsRequest, protos.google.monitoring.v3.IListMetricDescriptorsResponse | null | undefined, protos.google.api.IMetricDescriptor>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListMetricDescriptorsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.monitoring.v3.IListMetricDescriptorsRequest, protos.google.monitoring.v3.IListMetricDescriptorsResponse | null | undefined, protos.google.api.IMetricDescriptor>
|
| Returns | |
|---|---|
| Type | Description |
void | |
listMetricDescriptors(request, callback)
listMetricDescriptors(request: protos.google.monitoring.v3.IListMetricDescriptorsRequest, callback: PaginationCallback<protos.google.monitoring.v3.IListMetricDescriptorsRequest, protos.google.monitoring.v3.IListMetricDescriptorsResponse | null | undefined, protos.google.api.IMetricDescriptor>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListMetricDescriptorsRequest
|
callback |
PaginationCallback<protos.google.monitoring.v3.IListMetricDescriptorsRequest, protos.google.monitoring.v3.IListMetricDescriptorsResponse | null | undefined, protos.google.api.IMetricDescriptor>
|
| Returns | |
|---|---|
| Type | Description |
void | |
listMetricDescriptorsAsync(request, options)
listMetricDescriptorsAsync(request?: protos.google.monitoring.v3.IListMetricDescriptorsRequest, options?: CallOptions): AsyncIterable<protos.google.api.IMetricDescriptor>;Equivalent to listMetricDescriptors, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListMetricDescriptorsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.api.IMetricDescriptor> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [MetricDescriptor]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
const iterable = client.listMetricDescriptorsAsync(request); for await (const response of iterable) { // process response }
listMetricDescriptorsStream(request, options)
listMetricDescriptorsStream(request?: protos.google.monitoring.v3.IListMetricDescriptorsRequest, options?: CallOptions): Transform;Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListMetricDescriptorsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representing [MetricDescriptor] 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 |
listMonitoredResourceDescriptors(request, options)
listMonitoredResourceDescriptors(request: protos.google.monitoring.v3.IListMonitoredResourceDescriptorsRequest, options?: CallOptions): Promise<[
protos.google.api.IMonitoredResourceDescriptor[],
protos.google.monitoring.v3.IListMonitoredResourceDescriptorsRequest | null,
protos.google.monitoring.v3.IListMonitoredResourceDescriptorsResponse
]>;| Parameters | |
|---|---|
| Name | Description |
request |
IListMonitoredResourceDescriptorsRequest
|
options |
CallOptions
|
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.api.IMonitoredResourceDescriptor[],
protos.google.monitoring.v3.IListMonitoredResourceDescriptorsRequest | null,
protos.google.monitoring.v3.IListMonitoredResourceDescriptorsResponse
]> | |
listMonitoredResourceDescriptors(request, options, callback)
listMonitoredResourceDescriptors(request: protos.google.monitoring.v3.IListMonitoredResourceDescriptorsRequest, options: CallOptions, callback: PaginationCallback<protos.google.monitoring.v3.IListMonitoredResourceDescriptorsRequest, protos.google.monitoring.v3.IListMonitoredResourceDescriptorsResponse | null | undefined, protos.google.api.IMonitoredResourceDescriptor>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListMonitoredResourceDescriptorsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.monitoring.v3.IListMonitoredResourceDescriptorsRequest, protos.google.monitoring.v3.IListMonitoredResourceDescriptorsResponse | null | undefined, protos.google.api.IMonitoredResourceDescriptor>
|
| Returns | |
|---|---|
| Type | Description |
void | |
listMonitoredResourceDescriptors(request, callback)
listMonitoredResourceDescriptors(request: protos.google.monitoring.v3.IListMonitoredResourceDescriptorsRequest, callback: PaginationCallback<protos.google.monitoring.v3.IListMonitoredResourceDescriptorsRequest, protos.google.monitoring.v3.IListMonitoredResourceDescriptorsResponse | null | undefined, protos.google.api.IMonitoredResourceDescriptor>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListMonitoredResourceDescriptorsRequest
|
callback |
PaginationCallback<protos.google.monitoring.v3.IListMonitoredResourceDescriptorsRequest, protos.google.monitoring.v3.IListMonitoredResourceDescriptorsResponse | null | undefined, protos.google.api.IMonitoredResourceDescriptor>
|
| Returns | |
|---|---|
| Type | Description |
void | |
listMonitoredResourceDescriptorsAsync(request, options)
listMonitoredResourceDescriptorsAsync(request?: protos.google.monitoring.v3.IListMonitoredResourceDescriptorsRequest, options?: CallOptions): AsyncIterable<protos.google.api.IMonitoredResourceDescriptor>;Equivalent to listMonitoredResourceDescriptors, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListMonitoredResourceDescriptorsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.api.IMonitoredResourceDescriptor> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [MonitoredResourceDescriptor]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
const iterable = client.listMonitoredResourceDescriptorsAsync(request); for await (const response of iterable) { // process response }
listMonitoredResourceDescriptorsStream(request, options)
listMonitoredResourceDescriptorsStream(request?: protos.google.monitoring.v3.IListMonitoredResourceDescriptorsRequest, options?: CallOptions): Transform;Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListMonitoredResourceDescriptorsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representing [MonitoredResourceDescriptor] 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 |
listTimeSeries(request, options)
listTimeSeries(request: protos.google.monitoring.v3.IListTimeSeriesRequest, options?: CallOptions): Promise<[
protos.google.monitoring.v3.ITimeSeries[],
protos.google.monitoring.v3.IListTimeSeriesRequest | null,
protos.google.monitoring.v3.IListTimeSeriesResponse
]>;| Parameters | |
|---|---|
| Name | Description |
request |
IListTimeSeriesRequest
|
options |
CallOptions
|
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.monitoring.v3.ITimeSeries[],
protos.google.monitoring.v3.IListTimeSeriesRequest | null,
protos.google.monitoring.v3.IListTimeSeriesResponse
]> | |
listTimeSeries(request, options, callback)
listTimeSeries(request: protos.google.monitoring.v3.IListTimeSeriesRequest, options: CallOptions, callback: PaginationCallback<protos.google.monitoring.v3.IListTimeSeriesRequest, protos.google.monitoring.v3.IListTimeSeriesResponse | null | undefined, protos.google.monitoring.v3.ITimeSeries>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListTimeSeriesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.monitoring.v3.IListTimeSeriesRequest, protos.google.monitoring.v3.IListTimeSeriesResponse | null | undefined, protos.google.monitoring.v3.ITimeSeries>
|
| Returns | |
|---|---|
| Type | Description |
void | |
listTimeSeries(request, callback)
listTimeSeries(request: protos.google.monitoring.v3.IListTimeSeriesRequest, callback: PaginationCallback<protos.google.monitoring.v3.IListTimeSeriesRequest, protos.google.monitoring.v3.IListTimeSeriesResponse | null | undefined, protos.google.monitoring.v3.ITimeSeries>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListTimeSeriesRequest
|
callback |
PaginationCallback<protos.google.monitoring.v3.IListTimeSeriesRequest, protos.google.monitoring.v3.IListTimeSeriesResponse | null | undefined, protos.google.monitoring.v3.ITimeSeries>
|
| Returns | |
|---|---|
| Type | Description |
void | |
listTimeSeriesAsync(request, options)
listTimeSeriesAsync(request?: protos.google.monitoring.v3.IListTimeSeriesRequest, options?: CallOptions): AsyncIterable<protos.google.monitoring.v3.ITimeSeries>;Equivalent to listTimeSeries, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListTimeSeriesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.monitoring.v3.ITimeSeries> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [TimeSeries]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
const iterable = client.listTimeSeriesAsync(request); for await (const response of iterable) { // process response }
listTimeSeriesStream(request, options)
listTimeSeriesStream(request?: protos.google.monitoring.v3.IListTimeSeriesRequest, options?: CallOptions): Transform;Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListTimeSeriesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representing [TimeSeries] 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 |
matchAlertPolicyFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName)
matchAlertPolicyFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName: string): string | number;Parse the alert_policy from FolderAlertPolicyCondition resource.
| Parameter | |
|---|---|
| Name | Description |
folderAlertPolicyConditionName |
string
A fully-qualified path representing folder_alert_policy_condition resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the alert_policy. |
matchAlertPolicyFromFolderAlertPolicyName(folderAlertPolicyName)
matchAlertPolicyFromFolderAlertPolicyName(folderAlertPolicyName: string): string | number;Parse the alert_policy from FolderAlertPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
folderAlertPolicyName |
string
A fully-qualified path representing folder_alert_policy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the alert_policy. |
matchAlertPolicyFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName)
matchAlertPolicyFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName: string): string | number;Parse the alert_policy from OrganizationAlertPolicyCondition resource.
| Parameter | |
|---|---|
| Name | Description |
organizationAlertPolicyConditionName |
string
A fully-qualified path representing organization_alert_policy_condition resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the alert_policy. |
matchAlertPolicyFromOrganizationAlertPolicyName(organizationAlertPolicyName)
matchAlertPolicyFromOrganizationAlertPolicyName(organizationAlertPolicyName: string): string | number;Parse the alert_policy from OrganizationAlertPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
organizationAlertPolicyName |
string
A fully-qualified path representing organization_alert_policy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the alert_policy. |
matchAlertPolicyFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName)
matchAlertPolicyFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName: string): string | number;Parse the alert_policy from ProjectAlertPolicyCondition resource.
| Parameter | |
|---|---|
| Name | Description |
projectAlertPolicyConditionName |
string
A fully-qualified path representing project_alert_policy_condition resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the alert_policy. |
matchAlertPolicyFromProjectAlertPolicyName(projectAlertPolicyName)
matchAlertPolicyFromProjectAlertPolicyName(projectAlertPolicyName: string): string | number;Parse the alert_policy from ProjectAlertPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
projectAlertPolicyName |
string
A fully-qualified path representing project_alert_policy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the alert_policy. |
matchChannelDescriptorFromFolderChannelDescriptorName(folderChannelDescriptorName)
matchChannelDescriptorFromFolderChannelDescriptorName(folderChannelDescriptorName: string): string | number;Parse the channel_descriptor from FolderChannelDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
folderChannelDescriptorName |
string
A fully-qualified path representing folder_channel_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the channel_descriptor. |
matchChannelDescriptorFromOrganizationChannelDescriptorName(organizationChannelDescriptorName)
matchChannelDescriptorFromOrganizationChannelDescriptorName(organizationChannelDescriptorName: string): string | number;Parse the channel_descriptor from OrganizationChannelDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
organizationChannelDescriptorName |
string
A fully-qualified path representing organization_channel_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the channel_descriptor. |
matchChannelDescriptorFromProjectChannelDescriptorName(projectChannelDescriptorName)
matchChannelDescriptorFromProjectChannelDescriptorName(projectChannelDescriptorName: string): string | number;Parse the channel_descriptor from ProjectChannelDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
projectChannelDescriptorName |
string
A fully-qualified path representing project_channel_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the channel_descriptor. |
matchConditionFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName)
matchConditionFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName: string): string | number;Parse the condition from FolderAlertPolicyCondition resource.
| Parameter | |
|---|---|
| Name | Description |
folderAlertPolicyConditionName |
string
A fully-qualified path representing folder_alert_policy_condition resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the condition. |
matchConditionFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName)
matchConditionFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName: string): string | number;Parse the condition from OrganizationAlertPolicyCondition resource.
| Parameter | |
|---|---|
| Name | Description |
organizationAlertPolicyConditionName |
string
A fully-qualified path representing organization_alert_policy_condition resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the condition. |
matchConditionFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName)
matchConditionFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName: string): string | number;Parse the condition from ProjectAlertPolicyCondition resource.
| Parameter | |
|---|---|
| Name | Description |
projectAlertPolicyConditionName |
string
A fully-qualified path representing project_alert_policy_condition resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the condition. |
matchFolderFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName)
matchFolderFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName: string): string | number;Parse the folder from FolderAlertPolicyCondition resource.
| Parameter | |
|---|---|
| Name | Description |
folderAlertPolicyConditionName |
string
A fully-qualified path representing folder_alert_policy_condition resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderAlertPolicyName(folderAlertPolicyName)
matchFolderFromFolderAlertPolicyName(folderAlertPolicyName: string): string | number;Parse the folder from FolderAlertPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
folderAlertPolicyName |
string
A fully-qualified path representing folder_alert_policy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderChannelDescriptorName(folderChannelDescriptorName)
matchFolderFromFolderChannelDescriptorName(folderChannelDescriptorName: string): string | number;Parse the folder from FolderChannelDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
folderChannelDescriptorName |
string
A fully-qualified path representing folder_channel_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderGroupName(folderGroupName)
matchFolderFromFolderGroupName(folderGroupName: string): string | number;Parse the folder from FolderGroup resource.
| Parameter | |
|---|---|
| Name | Description |
folderGroupName |
string
A fully-qualified path representing folder_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderMetricDescriptorName(folderMetricDescriptorName)
matchFolderFromFolderMetricDescriptorName(folderMetricDescriptorName: string): string | number;Parse the folder from FolderMetricDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
folderMetricDescriptorName |
string
A fully-qualified path representing folder_metric_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderMonitoredResourceDescriptorName(folderMonitoredResourceDescriptorName)
matchFolderFromFolderMonitoredResourceDescriptorName(folderMonitoredResourceDescriptorName: string): string | number;Parse the folder from FolderMonitoredResourceDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
folderMonitoredResourceDescriptorName |
string
A fully-qualified path representing folder_monitored_resource_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderNotificationChannelName(folderNotificationChannelName)
matchFolderFromFolderNotificationChannelName(folderNotificationChannelName: string): string | number;Parse the folder from FolderNotificationChannel resource.
| Parameter | |
|---|---|
| Name | Description |
folderNotificationChannelName |
string
A fully-qualified path representing folder_notification_channel resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderServiceName(folderServiceName)
matchFolderFromFolderServiceName(folderServiceName: string): string | number;Parse the folder from FolderService resource.
| Parameter | |
|---|---|
| Name | Description |
folderServiceName |
string
A fully-qualified path representing folder_service resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName)
matchFolderFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName: string): string | number;Parse the folder from FolderServiceServiceLevelObjective resource.
| Parameter | |
|---|---|
| Name | Description |
folderServiceServiceLevelObjectiveName |
string
A fully-qualified path representing folder_service_service_level_objective resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName)
matchFolderFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName: string): string | number;Parse the folder from FolderUptimeCheckConfig resource.
| Parameter | |
|---|---|
| Name | Description |
folderUptimeCheckConfigName |
string
A fully-qualified path representing folder_uptime_check_config resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the folder. |
matchGroupFromFolderGroupName(folderGroupName)
matchGroupFromFolderGroupName(folderGroupName: string): string | number;Parse the group from FolderGroup resource.
| Parameter | |
|---|---|
| Name | Description |
folderGroupName |
string
A fully-qualified path representing folder_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the group. |
matchGroupFromOrganizationGroupName(organizationGroupName)
matchGroupFromOrganizationGroupName(organizationGroupName: string): string | number;Parse the group from OrganizationGroup resource.
| Parameter | |
|---|---|
| Name | Description |
organizationGroupName |
string
A fully-qualified path representing organization_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the group. |
matchGroupFromProjectGroupName(projectGroupName)
matchGroupFromProjectGroupName(projectGroupName: string): string | number;Parse the group from ProjectGroup resource.
| Parameter | |
|---|---|
| Name | Description |
projectGroupName |
string
A fully-qualified path representing project_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the group. |
matchMetricDescriptorFromFolderMetricDescriptorName(folderMetricDescriptorName)
matchMetricDescriptorFromFolderMetricDescriptorName(folderMetricDescriptorName: string): string | number;Parse the metric_descriptor from FolderMetricDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
folderMetricDescriptorName |
string
A fully-qualified path representing folder_metric_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the metric_descriptor. |
matchMetricDescriptorFromOrganizationMetricDescriptorName(organizationMetricDescriptorName)
matchMetricDescriptorFromOrganizationMetricDescriptorName(organizationMetricDescriptorName: string): string | number;Parse the metric_descriptor from OrganizationMetricDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
organizationMetricDescriptorName |
string
A fully-qualified path representing organization_metric_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the metric_descriptor. |
matchMetricDescriptorFromProjectMetricDescriptorName(projectMetricDescriptorName)
matchMetricDescriptorFromProjectMetricDescriptorName(projectMetricDescriptorName: string): string | number;Parse the metric_descriptor from ProjectMetricDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
projectMetricDescriptorName |
string
A fully-qualified path representing project_metric_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the metric_descriptor. |
matchMonitoredResourceDescriptorFromFolderMonitoredResourceDescriptorName(folderMonitoredResourceDescriptorName)
matchMonitoredResourceDescriptorFromFolderMonitoredResourceDescriptorName(folderMonitoredResourceDescriptorName: string): string | number;Parse the monitored_resource_descriptor from FolderMonitoredResourceDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
folderMonitoredResourceDescriptorName |
string
A fully-qualified path representing folder_monitored_resource_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the monitored_resource_descriptor. |
matchMonitoredResourceDescriptorFromOrganizationMonitoredResourceDescriptorName(organizationMonitoredResourceDescriptorName)
matchMonitoredResourceDescriptorFromOrganizationMonitoredResourceDescriptorName(organizationMonitoredResourceDescriptorName: string): string | number;Parse the monitored_resource_descriptor from OrganizationMonitoredResourceDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
organizationMonitoredResourceDescriptorName |
string
A fully-qualified path representing organization_monitored_resource_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the monitored_resource_descriptor. |
matchMonitoredResourceDescriptorFromProjectMonitoredResourceDescriptorName(projectMonitoredResourceDescriptorName)
matchMonitoredResourceDescriptorFromProjectMonitoredResourceDescriptorName(projectMonitoredResourceDescriptorName: string): string | number;Parse the monitored_resource_descriptor from ProjectMonitoredResourceDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
projectMonitoredResourceDescriptorName |
string
A fully-qualified path representing project_monitored_resource_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the monitored_resource_descriptor. |
matchNotificationChannelFromFolderNotificationChannelName(folderNotificationChannelName)
matchNotificationChannelFromFolderNotificationChannelName(folderNotificationChannelName: string): string | number;Parse the notification_channel from FolderNotificationChannel resource.
| Parameter | |
|---|---|
| Name | Description |
folderNotificationChannelName |
string
A fully-qualified path representing folder_notification_channel resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the notification_channel. |
matchNotificationChannelFromOrganizationNotificationChannelName(organizationNotificationChannelName)
matchNotificationChannelFromOrganizationNotificationChannelName(organizationNotificationChannelName: string): string | number;Parse the notification_channel from OrganizationNotificationChannel resource.
| Parameter | |
|---|---|
| Name | Description |
organizationNotificationChannelName |
string
A fully-qualified path representing organization_notification_channel resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the notification_channel. |
matchNotificationChannelFromProjectNotificationChannelName(projectNotificationChannelName)
matchNotificationChannelFromProjectNotificationChannelName(projectNotificationChannelName: string): string | number;Parse the notification_channel from ProjectNotificationChannel resource.
| Parameter | |
|---|---|
| Name | Description |
projectNotificationChannelName |
string
A fully-qualified path representing project_notification_channel resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the notification_channel. |
matchOrganizationFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName)
matchOrganizationFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName: string): string | number;Parse the organization from OrganizationAlertPolicyCondition resource.
| Parameter | |
|---|---|
| Name | Description |
organizationAlertPolicyConditionName |
string
A fully-qualified path representing organization_alert_policy_condition resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationAlertPolicyName(organizationAlertPolicyName)
matchOrganizationFromOrganizationAlertPolicyName(organizationAlertPolicyName: string): string | number;Parse the organization from OrganizationAlertPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
organizationAlertPolicyName |
string
A fully-qualified path representing organization_alert_policy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationChannelDescriptorName(organizationChannelDescriptorName)
matchOrganizationFromOrganizationChannelDescriptorName(organizationChannelDescriptorName: string): string | number;Parse the organization from OrganizationChannelDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
organizationChannelDescriptorName |
string
A fully-qualified path representing organization_channel_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationGroupName(organizationGroupName)
matchOrganizationFromOrganizationGroupName(organizationGroupName: string): string | number;Parse the organization from OrganizationGroup resource.
| Parameter | |
|---|---|
| Name | Description |
organizationGroupName |
string
A fully-qualified path representing organization_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationMetricDescriptorName(organizationMetricDescriptorName)
matchOrganizationFromOrganizationMetricDescriptorName(organizationMetricDescriptorName: string): string | number;Parse the organization from OrganizationMetricDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
organizationMetricDescriptorName |
string
A fully-qualified path representing organization_metric_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationMonitoredResourceDescriptorName(organizationMonitoredResourceDescriptorName)
matchOrganizationFromOrganizationMonitoredResourceDescriptorName(organizationMonitoredResourceDescriptorName: string): string | number;Parse the organization from OrganizationMonitoredResourceDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
organizationMonitoredResourceDescriptorName |
string
A fully-qualified path representing organization_monitored_resource_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationNotificationChannelName(organizationNotificationChannelName)
matchOrganizationFromOrganizationNotificationChannelName(organizationNotificationChannelName: string): string | number;Parse the organization from OrganizationNotificationChannel resource.
| Parameter | |
|---|---|
| Name | Description |
organizationNotificationChannelName |
string
A fully-qualified path representing organization_notification_channel resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationServiceName(organizationServiceName)
matchOrganizationFromOrganizationServiceName(organizationServiceName: string): string | number;Parse the organization from OrganizationService resource.
| Parameter | |
|---|---|
| Name | Description |
organizationServiceName |
string
A fully-qualified path representing organization_service resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName)
matchOrganizationFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName: string): string | number;Parse the organization from OrganizationServiceServiceLevelObjective resource.
| Parameter | |
|---|---|
| Name | Description |
organizationServiceServiceLevelObjectiveName |
string
A fully-qualified path representing organization_service_service_level_objective resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName)
matchOrganizationFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName: string): string | number;Parse the organization from OrganizationUptimeCheckConfig resource.
| Parameter | |
|---|---|
| Name | Description |
organizationUptimeCheckConfigName |
string
A fully-qualified path representing organization_uptime_check_config resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the organization. |
matchProjectFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName)
matchProjectFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName: string): string | number;Parse the project from ProjectAlertPolicyCondition resource.
| Parameter | |
|---|---|
| Name | Description |
projectAlertPolicyConditionName |
string
A fully-qualified path representing project_alert_policy_condition resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAlertPolicyName(projectAlertPolicyName)
matchProjectFromProjectAlertPolicyName(projectAlertPolicyName: string): string | number;Parse the project from ProjectAlertPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
projectAlertPolicyName |
string
A fully-qualified path representing project_alert_policy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectChannelDescriptorName(projectChannelDescriptorName)
matchProjectFromProjectChannelDescriptorName(projectChannelDescriptorName: string): string | number;Parse the project from ProjectChannelDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
projectChannelDescriptorName |
string
A fully-qualified path representing project_channel_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectGroupName(projectGroupName)
matchProjectFromProjectGroupName(projectGroupName: string): string | number;Parse the project from ProjectGroup resource.
| Parameter | |
|---|---|
| Name | Description |
projectGroupName |
string
A fully-qualified path representing project_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectMetricDescriptorName(projectMetricDescriptorName)
matchProjectFromProjectMetricDescriptorName(projectMetricDescriptorName: string): string | number;Parse the project from ProjectMetricDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
projectMetricDescriptorName |
string
A fully-qualified path representing project_metric_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectMonitoredResourceDescriptorName(projectMonitoredResourceDescriptorName)
matchProjectFromProjectMonitoredResourceDescriptorName(projectMonitoredResourceDescriptorName: string): string | number;Parse the project from ProjectMonitoredResourceDescriptor resource.
| Parameter | |
|---|---|
| Name | Description |
projectMonitoredResourceDescriptorName |
string
A fully-qualified path representing project_monitored_resource_descriptor resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;Parse the project from Project resource.
| Parameter | |
|---|---|
| Name | Description |
projectName |
string
A fully-qualified path representing Project resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectNotificationChannelName(projectNotificationChannelName)
matchProjectFromProjectNotificationChannelName(projectNotificationChannelName: string): string | number;Parse the project from ProjectNotificationChannel resource.
| Parameter | |
|---|---|
| Name | Description |
projectNotificationChannelName |
string
A fully-qualified path representing project_notification_channel resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectServiceName(projectServiceName)
matchProjectFromProjectServiceName(projectServiceName: string): string | number;Parse the project from ProjectService resource.
| Parameter | |
|---|---|
| Name | Description |
projectServiceName |
string
A fully-qualified path representing project_service resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName)
matchProjectFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName: string): string | number;Parse the project from ProjectServiceServiceLevelObjective resource.
| Parameter | |
|---|---|
| Name | Description |
projectServiceServiceLevelObjectiveName |
string
A fully-qualified path representing project_service_service_level_objective resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectTimeSeriesName(projectTimeSeriesName)
matchProjectFromProjectTimeSeriesName(projectTimeSeriesName: string): string | number;Parse the project from ProjectTimeSeries resource.
| Parameter | |
|---|---|
| Name | Description |
projectTimeSeriesName |
string
A fully-qualified path representing project_time_series resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName)
matchProjectFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName: string): string | number;Parse the project from ProjectUptimeCheckConfig resource.
| Parameter | |
|---|---|
| Name | Description |
projectUptimeCheckConfigName |
string
A fully-qualified path representing project_uptime_check_config resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchServiceFromFolderServiceName(folderServiceName)
matchServiceFromFolderServiceName(folderServiceName: string): string | number;Parse the service from FolderService resource.
| Parameter | |
|---|---|
| Name | Description |
folderServiceName |
string
A fully-qualified path representing folder_service resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the service. |
matchServiceFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName)
matchServiceFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName: string): string | number;Parse the service from FolderServiceServiceLevelObjective resource.
| Parameter | |
|---|---|
| Name | Description |
folderServiceServiceLevelObjectiveName |
string
A fully-qualified path representing folder_service_service_level_objective resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the service. |
matchServiceFromOrganizationServiceName(organizationServiceName)
matchServiceFromOrganizationServiceName(organizationServiceName: string): string | number;Parse the service from OrganizationService resource.
| Parameter | |
|---|---|
| Name | Description |
organizationServiceName |
string
A fully-qualified path representing organization_service resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the service. |
matchServiceFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName)
matchServiceFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName: string): string | number;Parse the service from OrganizationServiceServiceLevelObjective resource.
| Parameter | |
|---|---|
| Name | Description |
organizationServiceServiceLevelObjectiveName |
string
A fully-qualified path representing organization_service_service_level_objective resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the service. |
matchServiceFromProjectServiceName(projectServiceName)
matchServiceFromProjectServiceName(projectServiceName: string): string | number;Parse the service from ProjectService resource.
| Parameter | |
|---|---|
| Name | Description |
projectServiceName |
string
A fully-qualified path representing project_service resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the service. |
matchServiceFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName)
matchServiceFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName: string): string | number;Parse the service from ProjectServiceServiceLevelObjective resource.
| Parameter | |
|---|---|
| Name | Description |
projectServiceServiceLevelObjectiveName |
string
A fully-qualified path representing project_service_service_level_objective resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the service. |
matchServiceLevelObjectiveFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName)
matchServiceLevelObjectiveFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName: string): string | number;Parse the service_level_objective from FolderServiceServiceLevelObjective resource.
| Parameter | |
|---|---|
| Name | Description |
folderServiceServiceLevelObjectiveName |
string
A fully-qualified path representing folder_service_service_level_objective resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the service_level_objective. |
matchServiceLevelObjectiveFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName)
matchServiceLevelObjectiveFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName: string): string | number;Parse the service_level_objective from OrganizationServiceServiceLevelObjective resource.
| Parameter | |
|---|---|
| Name | Description |
organizationServiceServiceLevelObjectiveName |
string
A fully-qualified path representing organization_service_service_level_objective resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the service_level_objective. |
matchServiceLevelObjectiveFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName)
matchServiceLevelObjectiveFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName: string): string | number;Parse the service_level_objective from ProjectServiceServiceLevelObjective resource.
| Parameter | |
|---|---|
| Name | Description |
projectServiceServiceLevelObjectiveName |
string
A fully-qualified path representing project_service_service_level_objective resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the service_level_objective. |
matchTimeSeriesFromProjectTimeSeriesName(projectTimeSeriesName)
matchTimeSeriesFromProjectTimeSeriesName(projectTimeSeriesName: string): string | number;Parse the time_series from ProjectTimeSeries resource.
| Parameter | |
|---|---|
| Name | Description |
projectTimeSeriesName |
string
A fully-qualified path representing project_time_series resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the time_series. |
matchUptimeCheckConfigFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName)
matchUptimeCheckConfigFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName: string): string | number;Parse the uptime_check_config from FolderUptimeCheckConfig resource.
| Parameter | |
|---|---|
| Name | Description |
folderUptimeCheckConfigName |
string
A fully-qualified path representing folder_uptime_check_config resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the uptime_check_config. |
matchUptimeCheckConfigFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName)
matchUptimeCheckConfigFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName: string): string | number;Parse the uptime_check_config from OrganizationUptimeCheckConfig resource.
| Parameter | |
|---|---|
| Name | Description |
organizationUptimeCheckConfigName |
string
A fully-qualified path representing organization_uptime_check_config resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the uptime_check_config. |
matchUptimeCheckConfigFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName)
matchUptimeCheckConfigFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName: string): string | number;Parse the uptime_check_config from ProjectUptimeCheckConfig resource.
| Parameter | |
|---|---|
| Name | Description |
projectUptimeCheckConfigName |
string
A fully-qualified path representing project_uptime_check_config resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the uptime_check_config. |
organizationAlertPolicyConditionPath(organization, alertPolicy, condition)
organizationAlertPolicyConditionPath(organization: string, alertPolicy: string, condition: string): string;Return a fully-qualified organizationAlertPolicyCondition resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
alertPolicy |
string
|
condition |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
organizationAlertPolicyPath(organization, alertPolicy)
organizationAlertPolicyPath(organization: string, alertPolicy: string): string;Return a fully-qualified organizationAlertPolicy resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
alertPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
organizationChannelDescriptorPath(organization, channelDescriptor)
organizationChannelDescriptorPath(organization: string, channelDescriptor: string): string;Return a fully-qualified organizationChannelDescriptor resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
channelDescriptor |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
organizationGroupPath(organization, group)
organizationGroupPath(organization: string, group: string): string;Return a fully-qualified organizationGroup resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
group |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
organizationMetricDescriptorPath(organization, metricDescriptor)
organizationMetricDescriptorPath(organization: string, metricDescriptor: string): string;Return a fully-qualified organizationMetricDescriptor resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
metricDescriptor |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
organizationMonitoredResourceDescriptorPath(organization, monitoredResourceDescriptor)
organizationMonitoredResourceDescriptorPath(organization: string, monitoredResourceDescriptor: string): string;Return a fully-qualified organizationMonitoredResourceDescriptor resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
monitoredResourceDescriptor |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
organizationNotificationChannelPath(organization, notificationChannel)
organizationNotificationChannelPath(organization: string, notificationChannel: string): string;Return a fully-qualified organizationNotificationChannel resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
notificationChannel |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
organizationServicePath(organization, service)
organizationServicePath(organization: string, service: string): string;Return a fully-qualified organizationService resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
service |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
organizationServiceServiceLevelObjectivePath(organization, service, serviceLevelObjective)
organizationServiceServiceLevelObjectivePath(organization: string, service: string, serviceLevelObjective: string): string;Return a fully-qualified organizationServiceServiceLevelObjective resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
service |
string
|
serviceLevelObjective |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
organizationUptimeCheckConfigPath(organization, uptimeCheckConfig)
organizationUptimeCheckConfigPath(organization: string, uptimeCheckConfig: string): string;Return a fully-qualified organizationUptimeCheckConfig resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
uptimeCheckConfig |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectAlertPolicyConditionPath(project, alertPolicy, condition)
projectAlertPolicyConditionPath(project: string, alertPolicy: string, condition: string): string;Return a fully-qualified projectAlertPolicyCondition resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
alertPolicy |
string
|
condition |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectAlertPolicyPath(project, alertPolicy)
projectAlertPolicyPath(project: string, alertPolicy: string): string;Return a fully-qualified projectAlertPolicy resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
alertPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectChannelDescriptorPath(project, channelDescriptor)
projectChannelDescriptorPath(project: string, channelDescriptor: string): string;Return a fully-qualified projectChannelDescriptor resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
channelDescriptor |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectGroupPath(project, group)
projectGroupPath(project: string, group: string): string;Return a fully-qualified projectGroup resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
group |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectMetricDescriptorPath(project, metricDescriptor)
projectMetricDescriptorPath(project: string, metricDescriptor: string): string;Return a fully-qualified projectMetricDescriptor resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
metricDescriptor |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectMonitoredResourceDescriptorPath(project, monitoredResourceDescriptor)
projectMonitoredResourceDescriptorPath(project: string, monitoredResourceDescriptor: string): string;Return a fully-qualified projectMonitoredResourceDescriptor resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
monitoredResourceDescriptor |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectNotificationChannelPath(project, notificationChannel)
projectNotificationChannelPath(project: string, notificationChannel: string): string;Return a fully-qualified projectNotificationChannel resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
notificationChannel |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectPath(project)
projectPath(project: string): string;Return a fully-qualified project resource name string.
| Parameter | |
|---|---|
| Name | Description |
project |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectServicePath(project, service)
projectServicePath(project: string, service: string): string;Return a fully-qualified projectService resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
service |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectServiceServiceLevelObjectivePath(project, service, serviceLevelObjective)
projectServiceServiceLevelObjectivePath(project: string, service: string, serviceLevelObjective: string): string;Return a fully-qualified projectServiceServiceLevelObjective resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
service |
string
|
serviceLevelObjective |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectTimeSeriesPath(project, timeSeries)
projectTimeSeriesPath(project: string, timeSeries: string): string;Return a fully-qualified projectTimeSeries resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
timeSeries |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectUptimeCheckConfigPath(project, uptimeCheckConfig)
projectUptimeCheckConfigPath(project: string, uptimeCheckConfig: string): string;Return a fully-qualified projectUptimeCheckConfig resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
uptimeCheckConfig |
string
|
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |