Close httplib2 connections.
-This api is similar to GetStats except that the response is less verbose. In the current scheme, a query parameter _optimized instructs Edge Analytics to change the response but since this behavior is not possible with protocol buffer and since this parameter is predominantly used by Edge UI, we are introducing a separate api.
+Similar to GetStats except that the response is less verbose.
close()
@@ -88,25 +88,25 @@ get(name, accuracy=None, aggTable=None, filter=None, limit=None, offset=None, realtime=None, select=None, sonar=None, sort=None, sortby=None, timeRange=None, timeUnit=None, topk=None, tsAscending=None, tzo=None, x__xgafv=None)
- This api is similar to GetStats except that the response is less verbose. In the current scheme, a query parameter _optimized instructs Edge Analytics to change the response but since this behavior is not possible with protocol buffer and since this parameter is predominantly used by Edge UI, we are introducing a separate api.
+ Similar to GetStats except that the response is less verbose.
Args:
- name: string, Required. The resource name for which the interactive query will be executed. Must be of the form `organizations/{organization_id}/environments/{environment_id/optimizedStats/{dimensions}` Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below `organizations/{org}/environments/{env}/optimizedStats/apiproxy,request_verb` (required)
- accuracy: string, Legacy field: not used anymore.
- aggTable: string, If customers want to query custom aggregate tables, then this parameter can be used to specify the table name. If this parameter is skipped, then Edge Query will try to retrieve the data from fact tables which will be expensive.
- filter: string, Enables drill-down on specific dimension values.
- limit: string, This parameter is used to limit the number of result items. Default and the max value is 14400.
- offset: string, Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.
- realtime: boolean, Legacy field: not used anymore.
- select: string, Required. The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)
- sonar: boolean, This parameter routes the query to api monitoring service for last hour.
- sort: string, This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.
- sortby: string, Comma separated list of columns to sort the final result.
- timeRange: string, Required. Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59
- timeUnit: string, A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.
- topk: string, Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.
- tsAscending: boolean, Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.
- tzo: string, This parameters contains the timezone offset value.
+ name: string, Required. Resource name for which the interactive query will be executed. Use the following format in your request: `organizations/{org}/environments/{env}/optimizedStats/{dimensions}` Dimensions let you view metrics in meaningful groupings, such as `apiproxy`, `target_host`. The value of `dimensions` should be a comma-separated list as shown below: `organizations/{org}/environments/{env}/optimizedStats/apiproxy,request_verb` (required)
+ accuracy: string, No longer used by Apigee. Supported for backwards compatibility.
+ aggTable: string, Table name used to query custom aggregate tables. If this parameter is skipped, then Apigee will try to retrieve the data from fact tables which will be expensive.
+ filter: string, Filter that enables you to drill-down on specific dimension values.
+ limit: string, Maximum number of result items to return. The default and maximum value that can be returned is 14400.
+ offset: string, Offset value. Use `offset` with `limit` to enable pagination of results. For example, to display results 11-20, set limit to `10` and offset to `10`.
+ realtime: boolean, No longer used by Apigee. Supported for backwards compatibility.
+ select: string, Required. Comma-separated list of metrics. For example: `sum(message_count),sum(error_count)`
+ sonar: boolean, Routes the query to API Monitoring for the last hour.
+ sort: string, Flag that specifies whether the sort order should be ascending or descending. Valid values include `DESC` and `ASC`.
+ sortby: string, Comma-separated list of columns to sort the final result.
+ timeRange: string, Required. Time interval for the interactive query. Time range is specified in GMT as `start~end`. For example: `04/15/2017 00:00~05/15/2017 23:59`
+ timeUnit: string, Granularity of metrics returned. Valid values include: `second`, `minute`, `hour`, `day`, `week`, or `month`.
+ topk: string, Top number of results to return. For example, to return the top 5 results, set `topk=5`.
+ tsAscending: boolean, Flag that specifies whether to list timestamps in ascending (`true`) or descending (`false`) order. Apigee recommends setting this value to `true` if you are using `sortby` with `sort=DESC`.
+ tzo: string, Timezone offset value.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -116,20 +116,20 @@ Method Details
An object of the form:
{
- "Response": { # This message type encapsulates a response format for Js Optimized Scenario. # This field wraps the stats response for Js Optimized Scenario with a Response key. E.g. { "Response": { "TimeUnit": [], "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table used: edge.api.aaxgroup001.agg_api", "PG Host:ruappg08-ro.production.apigeeks.net", "query served by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }
- "TimeUnit": [ # This field contains a list of time unit values. Time unit refers to an epoch timestamp value.
+ "Response": { # Encapsulates a response format for JavaScript Optimized Scenario. # Wraps the `stats` response for JavaScript Optimized Scenario with a response key. For example: ```{ "Response": { "TimeUnit": [], "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table used: edge.api.aaxgroup001.agg_api", "PG Host:ruappg08-ro.production.apigeeks.net", "query served by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }```
+ "TimeUnit": [ # List of time unit values. Time unit refers to an epoch timestamp value.
"A String",
],
- "metaData": { # This message type encapsulates additional information about query execution. # This field contains metadata information about the query executed
+ "metaData": { # Encapsulates additional information about query execution. # Metadata information about the query executed.
"errors": [ # List of error messages as strings.
"A String",
],
- "notices": [ # List of additional information such as data source, if result was truncated etc. E.g "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api.uapgroup2.agg_api" ]
+ "notices": [ # List of additional information such as data source, if result was truncated. For example: ``` "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api.uapgroup2.agg_api" ]```
"A String",
],
},
- "resultTruncated": True or False, # This ia a boolean field to indicate if the results were truncated based on the limit parameter.
- "stats": { # This message type encapsulates a data node as represented below: { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] } OR { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] } Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics. # This field contains a stats results.
+ "resultTruncated": True or False, # Boolean flag that indicates whether the results were truncated based on the limit parameter.
+ "stats": { # Encapsulates a data node as represented below: ``` { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics. # `stats` results.
"data": [
"",
],
diff --git a/docs/dyn/apigee_v1.organizations.environments.stats.html b/docs/dyn/apigee_v1.organizations.environments.stats.html
index e1e61eb3590..c9784301cf0 100644
--- a/docs/dyn/apigee_v1.organizations.environments.stats.html
+++ b/docs/dyn/apigee_v1.organizations.environments.stats.html
@@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
-Retrieve metrics grouped by dimensions. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.
+Retrieve metrics grouped by dimensions. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to the `stats` API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.
Method Details
close()
@@ -88,25 +88,25 @@ Method Details
get(name, accuracy=None, aggTable=None, filter=None, limit=None, offset=None, realtime=None, select=None, sonar=None, sort=None, sortby=None, timeRange=None, timeUnit=None, topk=None, tsAscending=None, tzo=None, x__xgafv=None)
- Retrieve metrics grouped by dimensions. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.
+ Retrieve metrics grouped by dimensions. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to the `stats` API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.
Args:
- name: string, Required. The resource name for which the interactive query will be executed. Must be of the form `organizations/{organization_id}/environments/{environment_id/stats/{dimensions}` Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below `organizations/{org}/environments/{env}/stats/apiproxy,request_verb` (required)
- accuracy: string, Legacy field: not used anymore. This field is present to support UI calls which still use this parameter.
- aggTable: string, If customers want to query custom aggregate tables, then this parameter can be used to specify the table name. If this parameter is skipped, then Edge Query will try to retrieve the data from fact tables which will be expensive.
- filter: string, Enables drill-down on specific dimension values
- limit: string, This parameter is used to limit the number of result items. Default and the max value is 14400.
- offset: string, Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.
- realtime: boolean, Legacy field: not used anymore.
- select: string, The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)
- sonar: boolean, This parameter routes the query to api monitoring service for last hour.
- sort: string, This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.
- sortby: string, Comma separated list of columns to sort the final result.
- timeRange: string, Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59
- timeUnit: string, A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.
- topk: string, Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.
- tsAscending: boolean, Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.
- tzo: string, This parameters contains the timezone offset value.
+ name: string, Required. Resource name for which the interactive query will be executed. Use the following format in your request: `organizations/{org}/environments/{env}/stats/{dimensions}` Dimensions let you view metrics in meaningful groupings, such as `apiproxy` or `target_host`. The value of dimensions should be a comma-separated list, as shown below: `organizations/{org}/environments/{env}/stats/apiproxy,request_verb` (required)
+ accuracy: string, No longer used by Apigee. Supported for backwards compatibility.
+ aggTable: string, Table name used to query custom aggregate tables. If this parameter is skipped, then Apigee will try to retrieve the data from fact tables which will be expensive.
+ filter: string, Filter that enables you to drill down on specific dimension values.
+ limit: string, Maximum number of result items to return. The default and maximum value that can be returned is 14400.
+ offset: string, Offset value. Use `offset` with `limit` to enable pagination of results. For example, to display results 11-20, set limit to `10` and offset to `10`.
+ realtime: boolean, No longer used by Apigee. Supported for backwards compatibility.
+ select: string, Comma-separated list of metrics. For example: `sum(message_count),sum(error_count)`
+ sonar: boolean, Routes the query to API Monitoring for the last hour.
+ sort: string, Flag that specifies whether the sort order should be ascending or descending. Valid values include: `DESC` and `ASC`.
+ sortby: string, Comma-separated list of columns to sort the final result.
+ timeRange: string, Time interval for the interactive query. Time range is specified in GMT as `start~end`. For example: `04/15/2017 00:00~05/15/2017 23:59`
+ timeUnit: string, Granularity of metrics returned. Valid values include: `second`, `minute`, `hour`, `day`, `week`, or` month`.
+ topk: string, Top number of results to return. For example, to return the top 5 results, set `topk=5`.
+ tsAscending: boolean, Flag that specifies whether to list timestamps in ascending (`true`) or descending (`false`) order. Apigee recommends that you set this value to `true` if you are using `sortby` with `sort=DESC`.
+ tzo: string, Timezone offset value.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -115,64 +115,64 @@ Method Details
Returns:
An object of the form:
- { # This message type encapsulates a stats response.
- "environments": [ # This field contains a list of query results on environment level.
- { # This message type encapsulates the environment wrapper: "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "prod" } ]
- "dimensions": [ # This field contains the list of metrics grouped under dimensions.
- { # This message type encapsulates a metric grouped by dimension.
- "metrics": [ # This field contains a list of metrics.
- { # This message type encapsulates the metric data point. Example: { "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] } or { "name": "sum(message_count)", "values" : ["39.0"] }
- "name": "A String", # This field contains the metric name.
- "values": [ # List of metric values. Possible value format: "values":["39.0"] or "values":[ { "value": "39.0", "timestamp": 1232434354} ]
+ { # Encapsulates a `stats` response.
+ "environments": [ # List of query results on the environment level.
+ { # Encapsulates the environment wrapper: ``` "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "prod" } ]```
+ "dimensions": [ # List of metrics grouped under dimensions.
+ { # Encapsulates a metric grouped by dimension.
+ "metrics": [ # List of metrics.
+ { # Encapsulates the metric data point. For example: ```{ "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }```
+ "name": "A String", # Metric name.
+ "values": [ # List of metric values. Possible value formats include: `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": 1232434354} ]`
"",
],
},
],
- "name": "A String", # This field contains the name of the dimension.
+ "name": "A String", # Name of the dimension.
},
],
- "metrics": [ # In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only a top level metrics is provided. If dimensions are included, then there will be a top level dimensions field under environments which will contain metrics values and the dimension name. Example: "environments": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "prod" } ] OR "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": "prod" } ] This field contains the list of metric values.
- { # This message type encapsulates the metric data point. Example: { "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] } or { "name": "sum(message_count)", "values" : ["39.0"] }
- "name": "A String", # This field contains the metric name.
- "values": [ # List of metric values. Possible value format: "values":["39.0"] or "values":[ { "value": "39.0", "timestamp": 1232434354} ]
+ "metrics": [ # In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only top-level metrics is provided. If dimensions are included, then there will be a top-level dimensions field under environments which will contain metrics values and the dimension name. Example: ``` "environments": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "prod" } ]``` or ```"environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": "prod" } ]``` List of metric values.
+ { # Encapsulates the metric data point. For example: ```{ "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }```
+ "name": "A String", # Metric name.
+ "values": [ # List of metric values. Possible value formats include: `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": 1232434354} ]`
"",
],
},
],
- "name": "A String",
+ "name": "A String", # Name of the environment.
},
],
- "hosts": [ # This field contains a list of query results grouped by host.
- { # This message type encapsulates the hostname wrapper: "hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "example.com" } ]
- "dimensions": [ # This field contains the list of metrics grouped under dimensions.
- { # This message type encapsulates a metric grouped by dimension.
- "metrics": [ # This field contains a list of metrics.
- { # This message type encapsulates the metric data point. Example: { "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] } or { "name": "sum(message_count)", "values" : ["39.0"] }
- "name": "A String", # This field contains the metric name.
- "values": [ # List of metric values. Possible value format: "values":["39.0"] or "values":[ { "value": "39.0", "timestamp": 1232434354} ]
+ "hosts": [ # List of query results grouped by host.
+ { # Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "example.com" } ]```
+ "dimensions": [ # List of metrics grouped under dimensions.
+ { # Encapsulates a metric grouped by dimension.
+ "metrics": [ # List of metrics.
+ { # Encapsulates the metric data point. For example: ```{ "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }```
+ "name": "A String", # Metric name.
+ "values": [ # List of metric values. Possible value formats include: `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": 1232434354} ]`
"",
],
},
],
- "name": "A String", # This field contains the name of the dimension.
+ "name": "A String", # Name of the dimension.
},
],
- "metrics": [ # In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only a top level metrics is provided. If dimensions are included, then there will be a top level dimensions field under hostnames which will contain metrics values and the dimension name. Example: "hosts": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" } ] OR "hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": "example.com" } ] This field contains the list of metric values.
- { # This message type encapsulates the metric data point. Example: { "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] } or { "name": "sum(message_count)", "values" : ["39.0"] }
- "name": "A String", # This field contains the metric name.
- "values": [ # List of metric values. Possible value format: "values":["39.0"] or "values":[ { "value": "39.0", "timestamp": 1232434354} ]
+ "metrics": [ # In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only the top-level metrics are provided. If dimensions are included, then there will be a top-level dimensions field under hostnames which will contain metrics values and the dimension name. Example: ``` "hosts": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" } ]``` OR ```"hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": "example.com" } ]``` List of metric values.
+ { # Encapsulates the metric data point. For example: ```{ "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }```
+ "name": "A String", # Metric name.
+ "values": [ # List of metric values. Possible value formats include: `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": 1232434354} ]`
"",
],
},
],
- "name": "A String", # This field contains the hostname used in query.
+ "name": "A String", # Hostname used in query.
},
],
- "metaData": { # This message type encapsulates additional information about query execution. # This field contains the metadata information.
+ "metaData": { # Encapsulates additional information about query execution. # Metadata information.
"errors": [ # List of error messages as strings.
"A String",
],
- "notices": [ # List of additional information such as data source, if result was truncated etc. E.g "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api.uapgroup2.agg_api" ]
+ "notices": [ # List of additional information such as data source, if result was truncated. For example: ``` "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api.uapgroup2.agg_api" ]```
"A String",
],
},
diff --git a/docs/dyn/apigee_v1.organizations.hostStats.html b/docs/dyn/apigee_v1.organizations.hostStats.html
index e03a127dc17..ce70313524e 100644
--- a/docs/dyn/apigee_v1.organizations.hostStats.html
+++ b/docs/dyn/apigee_v1.organizations.hostStats.html
@@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
-Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.
+Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to the `stats` API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.
Method Details
close()
@@ -88,24 +88,24 @@ Method Details
get(name, accuracy=None, envgroupHostname=None, filter=None, limit=None, offset=None, realtime=None, select=None, sort=None, sortby=None, timeRange=None, timeUnit=None, topk=None, tsAscending=None, tzo=None, x__xgafv=None)
- Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.
+ Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to the `stats` API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.
Args:
- name: string, Required. The resource name for which the interactive query will be executed. Must be of the form `organizations/{organization_id}/hostStats/{dimensions}`. Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below `organizations/{org}/hostStats/apiproxy,request_verb` (required)
- accuracy: string, Legacy field: not used anymore.
- envgroupHostname: string, Required. The hostname for which the interactive query will be executed.
- filter: string, Enables drill-down on specific dimension values.
- limit: string, This parameter is used to limit the number of result items. Default and the max value is 14400.
- offset: string, Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.
- realtime: boolean, Legacy field: not used anymore.
- select: string, The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)
- sort: string, This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.
- sortby: string, Comma separated list of columns to sort the final result.
- timeRange: string, Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59
- timeUnit: string, A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.
- topk: string, Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.
- tsAscending: boolean, Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.
- tzo: string, This parameters contains the timezone offset value.
+ name: string, Required. Resource name for which the interactive query will be executed. Use the following format in your request: `organizations/{org}/hostStats/{dimensions}` Dimensions let you view metrics in meaningful groupings, such as `apiproxy`, `target_host`. The value of dimensions should be a comma-separated list as shown below `organizations/{org}/hostStats/apiproxy,request_verb` (required)
+ accuracy: string, No longer used by Apigee. Supported for backwards compatibility.
+ envgroupHostname: string, Required. Hostname for which the interactive query will be executed.
+ filter: string, Flag that enables drill-down on specific dimension values.
+ limit: string, Maximum number of result items to return. The default and maximum value that can be returned is 14400.
+ offset: string, Offset value. Use `offset` with `limit` to enable pagination of results. For example, to display results 11-20, set limit to `10` and offset to `10`.
+ realtime: boolean, No longer used by Apigee. Supported for backwards compatibility.
+ select: string, Comma-separated list of metrics. For example: `sum(message_count),sum(error_count)`
+ sort: string, Flag that specifies if the sort order should be ascending or descending. Valid values are `DESC` and `ASC`.
+ sortby: string, Comma-separated list of columns to sort the final result.
+ timeRange: string, Time interval for the interactive query. Time range is specified in GMT as `start~end`. For example: `04/15/2017 00:00~05/15/2017 23:59`
+ timeUnit: string, Granularity of metrics returned. Valid values include: `second`, `minute`, `hour`, `day`, `week`, or `month`.
+ topk: string, Top number of results to return. For example, to return the top 5 results, set `topk=5`.
+ tsAscending: boolean, Flag that specifies whether to list timestamps in ascending (`true`) or descending (`false`) order. Apigee recommends that you set this value to `true` if you are using `sortby` with `sort=DESC`.
+ tzo: string, Timezone offset value.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -114,64 +114,64 @@ Method Details
Returns:
An object of the form:
- { # This message type encapsulates a stats response.
- "environments": [ # This field contains a list of query results on environment level.
- { # This message type encapsulates the environment wrapper: "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "prod" } ]
- "dimensions": [ # This field contains the list of metrics grouped under dimensions.
- { # This message type encapsulates a metric grouped by dimension.
- "metrics": [ # This field contains a list of metrics.
- { # This message type encapsulates the metric data point. Example: { "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] } or { "name": "sum(message_count)", "values" : ["39.0"] }
- "name": "A String", # This field contains the metric name.
- "values": [ # List of metric values. Possible value format: "values":["39.0"] or "values":[ { "value": "39.0", "timestamp": 1232434354} ]
+ { # Encapsulates a `stats` response.
+ "environments": [ # List of query results on the environment level.
+ { # Encapsulates the environment wrapper: ``` "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "prod" } ]```
+ "dimensions": [ # List of metrics grouped under dimensions.
+ { # Encapsulates a metric grouped by dimension.
+ "metrics": [ # List of metrics.
+ { # Encapsulates the metric data point. For example: ```{ "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }```
+ "name": "A String", # Metric name.
+ "values": [ # List of metric values. Possible value formats include: `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": 1232434354} ]`
"",
],
},
],
- "name": "A String", # This field contains the name of the dimension.
+ "name": "A String", # Name of the dimension.
},
],
- "metrics": [ # In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only a top level metrics is provided. If dimensions are included, then there will be a top level dimensions field under environments which will contain metrics values and the dimension name. Example: "environments": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "prod" } ] OR "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": "prod" } ] This field contains the list of metric values.
- { # This message type encapsulates the metric data point. Example: { "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] } or { "name": "sum(message_count)", "values" : ["39.0"] }
- "name": "A String", # This field contains the metric name.
- "values": [ # List of metric values. Possible value format: "values":["39.0"] or "values":[ { "value": "39.0", "timestamp": 1232434354} ]
+ "metrics": [ # In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only top-level metrics is provided. If dimensions are included, then there will be a top-level dimensions field under environments which will contain metrics values and the dimension name. Example: ``` "environments": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "prod" } ]``` or ```"environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": "prod" } ]``` List of metric values.
+ { # Encapsulates the metric data point. For example: ```{ "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }```
+ "name": "A String", # Metric name.
+ "values": [ # List of metric values. Possible value formats include: `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": 1232434354} ]`
"",
],
},
],
- "name": "A String",
+ "name": "A String", # Name of the environment.
},
],
- "hosts": [ # This field contains a list of query results grouped by host.
- { # This message type encapsulates the hostname wrapper: "hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "example.com" } ]
- "dimensions": [ # This field contains the list of metrics grouped under dimensions.
- { # This message type encapsulates a metric grouped by dimension.
- "metrics": [ # This field contains a list of metrics.
- { # This message type encapsulates the metric data point. Example: { "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] } or { "name": "sum(message_count)", "values" : ["39.0"] }
- "name": "A String", # This field contains the metric name.
- "values": [ # List of metric values. Possible value format: "values":["39.0"] or "values":[ { "value": "39.0", "timestamp": 1232434354} ]
+ "hosts": [ # List of query results grouped by host.
+ { # Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "example.com" } ]```
+ "dimensions": [ # List of metrics grouped under dimensions.
+ { # Encapsulates a metric grouped by dimension.
+ "metrics": [ # List of metrics.
+ { # Encapsulates the metric data point. For example: ```{ "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }```
+ "name": "A String", # Metric name.
+ "values": [ # List of metric values. Possible value formats include: `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": 1232434354} ]`
"",
],
},
],
- "name": "A String", # This field contains the name of the dimension.
+ "name": "A String", # Name of the dimension.
},
],
- "metrics": [ # In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only a top level metrics is provided. If dimensions are included, then there will be a top level dimensions field under hostnames which will contain metrics values and the dimension name. Example: "hosts": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" } ] OR "hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": "example.com" } ] This field contains the list of metric values.
- { # This message type encapsulates the metric data point. Example: { "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] } or { "name": "sum(message_count)", "values" : ["39.0"] }
- "name": "A String", # This field contains the metric name.
- "values": [ # List of metric values. Possible value format: "values":["39.0"] or "values":[ { "value": "39.0", "timestamp": 1232434354} ]
+ "metrics": [ # In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only the top-level metrics are provided. If dimensions are included, then there will be a top-level dimensions field under hostnames which will contain metrics values and the dimension name. Example: ``` "hosts": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" } ]``` OR ```"hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": "example.com" } ]``` List of metric values.
+ { # Encapsulates the metric data point. For example: ```{ "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }```
+ "name": "A String", # Metric name.
+ "values": [ # List of metric values. Possible value formats include: `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": 1232434354} ]`
"",
],
},
],
- "name": "A String", # This field contains the hostname used in query.
+ "name": "A String", # Hostname used in query.
},
],
- "metaData": { # This message type encapsulates additional information about query execution. # This field contains the metadata information.
+ "metaData": { # Encapsulates additional information about query execution. # Metadata information.
"errors": [ # List of error messages as strings.
"A String",
],
- "notices": [ # List of additional information such as data source, if result was truncated etc. E.g "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api.uapgroup2.agg_api" ]
+ "notices": [ # List of additional information such as data source, if result was truncated. For example: ``` "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api.uapgroup2.agg_api" ]```
"A String",
],
},
diff --git a/docs/dyn/apigee_v1.organizations.optimizedHostStats.html b/docs/dyn/apigee_v1.organizations.optimizedHostStats.html
index d52d8fa61ee..a742477aaec 100644
--- a/docs/dyn/apigee_v1.organizations.optimizedHostStats.html
+++ b/docs/dyn/apigee_v1.organizations.optimizedHostStats.html
@@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
-This api is similar to GetHostStats except that the response is less verbose.
+Similar to GetHostStats except that the response is less verbose.
Method Details
close()
@@ -88,24 +88,24 @@ Method Details
get(name, accuracy=None, envgroupHostname=None, filter=None, limit=None, offset=None, realtime=None, select=None, sort=None, sortby=None, timeRange=None, timeUnit=None, topk=None, tsAscending=None, tzo=None, x__xgafv=None)
- This api is similar to GetHostStats except that the response is less verbose.
+ Similar to GetHostStats except that the response is less verbose.
Args:
- name: string, Required. The resource name for which the interactive query will be executed. Must be of the form `organizations/{organization_id}/optimizedHostStats/{dimensions}`. Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below `organizations/{org}/optimizedHostStats/apiproxy,request_verb` (required)
- accuracy: string, Legacy field: not used anymore.
- envgroupHostname: string, Required. The hostname for which the interactive query will be executed.
- filter: string, Enables drill-down on specific dimension values.
- limit: string, This parameter is used to limit the number of result items. Default and the max value is 14400.
- offset: string, Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.
- realtime: boolean, Legacy field: not used anymore.
- select: string, Required. The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)
- sort: string, This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.
- sortby: string, Comma separated list of columns to sort the final result.
- timeRange: string, Required. Time interval for the interactive query. Time range is specified as start~end. E.g 04/15/2017 00:00~05/15/2017 23:59.
- timeUnit: string, A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.
- topk: string, Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.
- tsAscending: boolean, Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.
- tzo: string, This parameters contains the timezone offset value.
+ name: string, Required. Resource name for which the interactive query will be executed. Use the following format in your request: `organizations/{organization_id}/optimizedHostStats/{dimensions}` Dimensions let you view metrics in meaningful groupings, such as `apiproxy`, `target_host`. The value of dimensions should be a comma-separated list as shown below: `organizations/{org}/optimizedHostStats/apiproxy,request_verb` (required)
+ accuracy: string, No longer used by Apigee. Supported for backwards compatibility.
+ envgroupHostname: string, Required. Hostname for which the interactive query will be executed.
+ filter: string, Filter that enables you to drill-down on specific dimension values.
+ limit: string, Maximum number of result items to return. The default and maximum value that can be returned is 14400.
+ offset: string, Offset value. Use `offset` with `limit` to enable pagination of results. For example, to display results 11-20, set limit to `10` and offset to `10`.
+ realtime: boolean, No longer used by Apigee. Supported for backwards compatibility.
+ select: string, Required. Comma-separated list of metrics. For example: `sum(message_count),sum(error_count)`
+ sort: string, Flag that specifies whether the sort order should be ascending or descending. Valid values include `DESC` and `ASC`.
+ sortby: string, Comma-separated list of columns used to sort the final result.
+ timeRange: string, Required. Time interval for the interactive query. Time range is specified in GMT as `start~end`. For example: `04/15/2017 00:00~05/15/2017 23:59`.
+ timeUnit: string, Granularity of metrics returned. Valid values include: `second`, `minute`, `hour`, `day`, `week`, or `month`.
+ topk: string, Top number of results to return. For example, to return the top 5 results, set `topk=5`.
+ tsAscending: boolean, Flag that specifies whether to list timestamps in ascending (`true`) or descending (`false`) order. Apigee recommends that you set this value to `true` if you are using `sortby` with `sort=DESC`.
+ tzo: string, Timezone offset value.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -115,20 +115,20 @@ Method Details
An object of the form:
{
- "Response": { # This message type encapsulates a response format for Js Optimized Scenario. # This field wraps the stats response for Js Optimized Scenario with a Response key. E.g. { "Response": { "TimeUnit": [], "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table used: edge.api.aaxgroup001.agg_api", "PG Host:ruappg08-ro.production.apigeeks.net", "query served by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }
- "TimeUnit": [ # This field contains a list of time unit values. Time unit refers to an epoch timestamp value.
+ "Response": { # Encapsulates a response format for JavaScript Optimized Scenario. # Wraps the `stats` response for JavaScript Optimized Scenario with a response key. For example: ```{ "Response": { "TimeUnit": [], "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table used: edge.api.aaxgroup001.agg_api", "PG Host:ruappg08-ro.production.apigeeks.net", "query served by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }```
+ "TimeUnit": [ # List of time unit values. Time unit refers to an epoch timestamp value.
"A String",
],
- "metaData": { # This message type encapsulates additional information about query execution. # This field contains metadata information about the query executed
+ "metaData": { # Encapsulates additional information about query execution. # Metadata information about the query executed.
"errors": [ # List of error messages as strings.
"A String",
],
- "notices": [ # List of additional information such as data source, if result was truncated etc. E.g "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api.uapgroup2.agg_api" ]
+ "notices": [ # List of additional information such as data source, if result was truncated. For example: ``` "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api.uapgroup2.agg_api" ]```
"A String",
],
},
- "resultTruncated": True or False, # This ia a boolean field to indicate if the results were truncated based on the limit parameter.
- "stats": { # This message type encapsulates a data node as represented below: { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] } OR { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] } Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics. # This field contains a stats results.
+ "resultTruncated": True or False, # Boolean flag that indicates whether the results were truncated based on the limit parameter.
+ "stats": { # Encapsulates a data node as represented below: ``` { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics. # `stats` results.
"data": [
"",
],
diff --git a/docs/dyn/appengine_v1alpha.html b/docs/dyn/appengine_v1alpha.html
index e93bc03ff02..2ce76942c4c 100644
--- a/docs/dyn/appengine_v1alpha.html
+++ b/docs/dyn/appengine_v1alpha.html
@@ -79,6 +79,11 @@ Instance Methods
Returns the apps Resource.
+
+ projects()
+
+Returns the projects Resource.
+
Close httplib2 connections.
diff --git a/docs/dyn/appengine_v1alpha.projects.html b/docs/dyn/appengine_v1alpha.projects.html
new file mode 100644
index 00000000000..949e7aaf853
--- /dev/null
+++ b/docs/dyn/appengine_v1alpha.projects.html
@@ -0,0 +1,91 @@
+
+
+
+App Engine Admin API . projects
+Instance Methods
+
+ locations()
+
+Returns the locations Resource.
+
+
+ close()
+Close httplib2 connections.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/appengine_v1alpha.projects.locations.html b/docs/dyn/appengine_v1alpha.projects.locations.html
new file mode 100644
index 00000000000..29df4651daf
--- /dev/null
+++ b/docs/dyn/appengine_v1alpha.projects.locations.html
@@ -0,0 +1,177 @@
+
+
+
+App Engine Admin API . projects . locations
+Instance Methods
+
+ operations()
+
+Returns the operations Resource.
+
+
+ close()
+Close httplib2 connections.
+
+ get(projectsId, locationsId, x__xgafv=None)
+Gets information about a location.
+
+ list(projectsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists information about the supported locations for this service.
+
+ list_next(previous_request, previous_response)
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(projectsId, locationsId, x__xgafv=None)
+ Gets information about a location.
+
+Args:
+ projectsId: string, Part of `name`. Resource name for the location. (required)
+ locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A resource that represents Google Cloud Platform location.
+ "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: "us-east1".
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
+}
+
+
+
+ list(projectsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists information about the supported locations for this service.
+
+Args:
+ projectsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required)
+ filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).
+ pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+ pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Locations.ListLocations.
+ "locations": [ # A list of locations that matches the specified filter in the request.
+ { # A resource that represents Google Cloud Platform location.
+ "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: "us-east1".
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
+ },
+ ],
+ "nextPageToken": "A String", # The standard List next-page token.
+}
+
+
+
+ list_next(previous_request, previous_response)
+ 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.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/appengine_v1alpha.projects.locations.operations.html b/docs/dyn/appengine_v1alpha.projects.locations.operations.html
new file mode 100644
index 00000000000..775106a216f
--- /dev/null
+++ b/docs/dyn/appengine_v1alpha.projects.locations.operations.html
@@ -0,0 +1,190 @@
+
+
+
+App Engine Admin API . projects . locations . operations
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ get(projectsId, locationsId, operationsId, x__xgafv=None)
+Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+ list(projectsId, locationsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
+
+ list_next(previous_request, previous_response)
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(projectsId, locationsId, operationsId, x__xgafv=None)
+ Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ projectsId: string, Part of `name`. The name of the operation resource. (required)
+ locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+ operationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ list(projectsId, locationsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
+
+Args:
+ projectsId: string, Part of `name`. The name of the operation's parent resource. (required)
+ locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+ filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
+ pageToken: string, The standard list page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+}
+
+
+
+ list_next(previous_request, previous_response)
+ 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.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/artifactregistry_v1beta2.projects.html b/docs/dyn/artifactregistry_v1beta2.projects.html
index 6cc3315fadb..6a449366977 100644
--- a/docs/dyn/artifactregistry_v1beta2.projects.html
+++ b/docs/dyn/artifactregistry_v1beta2.projects.html
@@ -82,10 +82,65 @@ Instance Methods
Close httplib2 connections.
+
+ getProjectSettings(name, x__xgafv=None)
+Retrieves the Settings for the Project
+
+ updateProjectSettings(name, body=None, updateMask=None, x__xgafv=None)
+Retrieves the Settings for the Project
Method Details
close()
Close httplib2 connections.
+
+ getProjectSettings(name, x__xgafv=None)
+ Retrieves the Settings for the Project
+
+Args:
+ name: string, Required. The name of the projectSettings resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The Artifact Registry settings that apply to a Project.
+ "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project.
+ "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set
+}
+
+
+
+ updateProjectSettings(name, body=None, updateMask=None, x__xgafv=None)
+ Retrieves the Settings for the Project
+
+Args:
+ name: string, The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The Artifact Registry settings that apply to a Project.
+ "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project.
+ "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set
+}
+
+ updateMask: string, Field mask to support partial updates.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The Artifact Registry settings that apply to a Project.
+ "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project.
+ "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set
+}
+
+