DashboardsServiceClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.
Inheritance
builtins.object > google.cloud.monitoring_dashboard.v1.gapic.dashboards_service_client.DashboardsServiceClient > DashboardsServiceClientMethods
DashboardsServiceClient
DashboardsServiceClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)Constructor.
| Name | Description |
| channel |
grpc.Channel
DEPRECATED. A |
| credentials |
google.auth.credentials.Credentials
The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to |
| client_config |
dict
DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used. |
| client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| client_options |
Union[dict, google.api_core.client_options.ClientOptions]
Client options used to set user options on the client. API Endpoint should be set through client_options. |
create_dashboard
create_dashboard(parent, dashboard, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Identifies which part of the FileDescriptorProto was defined at this location.
Each element is a field number or an index. They form a path from the root FileDescriptorProto to the place where the definition. For example, this path: [ 4, 3, 2, 7, 1 ] refers to: file.message_type(3) // 4, 3 .field(7) // 2, 7 .name() // 1 This is because FileDescriptorProto.message_type has field number 4: repeated DescriptorProto message_type = 4; and DescriptorProto.field has field number 2: repeated FieldDescriptorProto field = 2; and FieldDescriptorProto.name has field number 1: optional string name = 1;
Thus, the above path gives the location of a field name. If we removed the last element: [ 4, 3, 2, 7 ] this path refers to the whole field declaration (from the beginning of the label to the terminating semicolon).
.. rubric:: Example
from google.cloud.monitoring_dashboard import v1
client = v1.DashboardsServiceClient()
TODO: Initialize
parent:parent = ''
TODO: Initialize
dashboard:dashboard = {}
response = client.create_dashboard(parent, dashboard)
| Name | Description |
| parent |
str
Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type. |
| dashboard |
Union[dict, Dashboard]
Required. The initial dashboard specification. If a dict is provided, it must be of the same form as the protobuf message Dashboard |
| retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
| timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
| metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Type | Description |
| google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
| google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
| ValueError | If the parameters are invalid. |
delete_dashboard
delete_dashboard(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
::
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.. rubric:: Example
from google.cloud.monitoring_dashboard import v1
client = v1.DashboardsServiceClient()
TODO: Initialize
name:name = ''
client.delete_dashboard(name)
| Name | Description |
| name |
str
The |
| retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
| timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
| metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Type | Description |
| google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
| google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
| ValueError | If the parameters are invalid. |
from_service_account_file
from_service_account_file(filename, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| DashboardsServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| DashboardsServiceClient | The constructed client. |
get_dashboard
get_dashboard(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Align and convert to a percentage change. This alignment is valid
for gauge and delta metrics with numeric values. This alignment
conceptually computes the equivalent of "((current -
previous)/previous)*100" where previous value is determined based on the
alignmentPeriod. In the event that previous is 0 the calculated value is
infinity with the exception that if both (current - previous) and
previous are 0 the calculated value is 0. A 10 minute moving mean is
computed at each point of the time window prior to the above calculation
to smooth the metric and prevent false positives from very short lived
spikes. Only applicable for data that is >= 0. Any values < 0 are
treated as no data. While delta metrics are accepted by this alignment
special care should be taken that the values for the metric will always
be positive. The output is a gauge metric with value type DOUBLE.
.. rubric:: Example
from google.cloud.monitoring_dashboard import v1
client = v1.DashboardsServiceClient()
TODO: Initialize
name:name = ''
response = client.get_dashboard(name)
| Name | Description |
| name |
str
Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed. This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it. This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access. Note that implementations may choose not to check required fields within a lazy sub-message. That is, calling IsInitialized() on the outer message may return true even if the inner message has missing required fields. This is necessary because otherwise the inner message would have to be parsed in order to perform the check, defeating the purpose of lazy parsing. An implementation which chooses not to check required fields must be consistent about it. That is, for any particular sub-message, the implementation must either always check its required fields, or never check its required fields, regardless of whether or not the message has been parsed. |
| retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
| timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
| metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Type | Description |
| google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
| google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
| ValueError | If the parameters are invalid. |
list_dashboards
list_dashboards(parent, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)An annotation that describes a resource definition without a
corresponding message; see ResourceDescriptor.
.. rubric:: Example
from google.cloud.monitoring_dashboard import v1
client = v1.DashboardsServiceClient()
TODO: Initialize
parent:parent = ''
Iterate over all results
for element in client.list_dashboards(parent): ... # process element ... pass
Alternatively:
Iterate over results one page at a time
for page in client.list_dashboards(parent).pages: ... for element in page: ... # process element ... pass
| Name | Description |
| parent |
str
Reduce by computing the count of True-valued data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of Boolean value type. The value type of the output is |
| page_size |
int
The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. |
| retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
| timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
| metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Type | Description |
| google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
| google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
| ValueError | If the parameters are invalid. |
update_dashboard
update_dashboard(dashboard, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Deletes an existing custom dashboard.
This method requires the monitoring.dashboards.delete permission on
the specified dashboard. For more information, see Google Cloud
IAM <https://cloud.google.com/iam>__.
.. rubric:: Example
from google.cloud.monitoring_dashboard import v1
client = v1.DashboardsServiceClient()
TODO: Initialize
dashboard:dashboard = {}
response = client.update_dashboard(dashboard)
| Name | Description |
| dashboard |
Union[dict, Dashboard]
Required. The dashboard that will replace the existing dashboard. If a dict is provided, it must be of the same form as the protobuf message Dashboard |
| retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
| timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
| metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Type | Description |
| google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
| google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
| ValueError | If the parameters are invalid. |