| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="monitoring_v3.html">Cloud Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.monitoredResourceDescriptors.html">monitoredResourceDescriptors</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a single monitored resource descriptor. This method does not require a Workspace.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists monitored resource descriptors that match a filter. This method does not require a Workspace.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets a single monitored resource descriptor. This method does not require a Workspace. |
| |
| Args: |
| name: string, Required. The monitored resource descriptor to get. The format is: |
| projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] |
| The [RESOURCE_TYPE] is a predefined type, such as cloudsql_database. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different services can support different monitored resource types.The following are specific rules to service defined monitored resources for Monitoring and Logging: |
| # The type, display_name, description, labels and launch_stage fields are all required. |
| # The first label of the monitored resource descriptor must be resource_container. There are legacy monitored resource descritptors start with project_id. |
| # It must include a location label. |
| # Maximum of default 5 service defined monitored resource descriptors is allowed per service. |
| # Maximum of default 10 labels per monitored resource is allowed.The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas |
| "displayName": "A String", # Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database". |
| "labels": [ # Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: |
| # Only upper and lower-case letters, digits and underscores (_) are allowed. |
| # Label name must start with a letter or digit. |
| # The maximum length of a label name is 100 characters.For example, an individual Google Cloud SQL database is identified by values for the labels database_id and location. |
| { # A description of a label. |
| "key": "A String", # The key for this label. The key must meet the following criteria: |
| # Does not exceed 100 characters. |
| # Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* |
| # The first character must be an upper- or lower-case letter. |
| # The remaining characters must be letters, digits, or underscores. |
| "description": "A String", # A human-readable description for the label. |
| "valueType": "A String", # The type of data that can be assigned to the label. |
| }, |
| ], |
| "name": "A String", # Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". |
| "launchStage": "A String", # Optional. The launch stage of the monitored resource definition. |
| "type": "A String", # Required. The monitored resource type. For example, the type cloudsql_database represents databases in Google Cloud SQL.All service defined monitored resource types must be prefixed with the service name, in the format of {service name}/{relative resource name}. The relative resource name must follow: |
| # Only upper and lower-case letters and digits are allowed. |
| # It must start with upper case character and is recommended to use Upper Camel Case style. |
| # The maximum number of characters allowed for the relative_resource_name is 100.Note there are legacy service monitored resources not following this rule. |
| "description": "A String", # Optional. A detailed description of the monitored resource type that might be used in documentation. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists monitored resource descriptors that match a filter. This method does not require a Workspace. |
| |
| Args: |
| name: string, Required. The project on which to execute the request. The format is: |
| projects/[PROJECT_ID_OR_NUMBER] |
| (required) |
| filter: string, An optional filter (https://cloud.google.com/monitoring/api/v3/filters) describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label: |
| resource.type = starts_with("gce_") AND resource.label:id |
| |
| pageSize: integer, A positive number that is the maximum number of results to return. |
| pageToken: string, 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The ListMonitoredResourceDescriptors response. |
| "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. |
| "resourceDescriptors": [ # The monitored resource descriptors that are available to this project and that match filter, if present. |
| { # An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different services can support different monitored resource types.The following are specific rules to service defined monitored resources for Monitoring and Logging: |
| # The type, display_name, description, labels and launch_stage fields are all required. |
| # The first label of the monitored resource descriptor must be resource_container. There are legacy monitored resource descritptors start with project_id. |
| # It must include a location label. |
| # Maximum of default 5 service defined monitored resource descriptors is allowed per service. |
| # Maximum of default 10 labels per monitored resource is allowed.The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas |
| "displayName": "A String", # Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database". |
| "labels": [ # Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: |
| # Only upper and lower-case letters, digits and underscores (_) are allowed. |
| # Label name must start with a letter or digit. |
| # The maximum length of a label name is 100 characters.For example, an individual Google Cloud SQL database is identified by values for the labels database_id and location. |
| { # A description of a label. |
| "key": "A String", # The key for this label. The key must meet the following criteria: |
| # Does not exceed 100 characters. |
| # Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* |
| # The first character must be an upper- or lower-case letter. |
| # The remaining characters must be letters, digits, or underscores. |
| "description": "A String", # A human-readable description for the label. |
| "valueType": "A String", # The type of data that can be assigned to the label. |
| }, |
| ], |
| "name": "A String", # Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". |
| "launchStage": "A String", # Optional. The launch stage of the monitored resource definition. |
| "type": "A String", # Required. The monitored resource type. For example, the type cloudsql_database represents databases in Google Cloud SQL.All service defined monitored resource types must be prefixed with the service name, in the format of {service name}/{relative resource name}. The relative resource name must follow: |
| # Only upper and lower-case letters and digits are allowed. |
| # It must start with upper case character and is recommended to use Upper Camel Case style. |
| # The maximum number of characters allowed for the relative_resource_name is 100.Note there are legacy service monitored resources not following this rule. |
| "description": "A String", # Optional. A detailed description of the monitored resource type that might be used in documentation. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
