google-apis-apigee_v1 0.25.0 → 0.26.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 56e1f90809c2a70ad4ecf7314b31fcf448661dac238e949599fe42622eba128e
4
- data.tar.gz: 848024b772549599b6c1807af6b99cefe8c526b2fee89554a1c1ca12fa8cecb3
3
+ metadata.gz: d5df0c3830c56bebf4f19e70ccd3b789acfbfe3356992cb6ac79469315af800d
4
+ data.tar.gz: 3a6468bb3d87b35f80bc73fa8d88a71719c93f7edd5af09671ea3270d9e917fb
5
5
  SHA512:
6
- metadata.gz: 2a872225bf8b28f0f5e6b4c9b5a3467aae8c49b625eea9a26d2f277782afded89cf0ac180db0e9aad9142cc5a47baa02363e59ca449bd463eabe357e49775b6e
7
- data.tar.gz: 18ae1dfae33c49ddfbb7622acf2c1ff0c1aff9022435624688fd6f0cc31f64fd2a7e1cddafe554f17a4a0ff58e0925197e7320d9108ddd5c215e7392828f9120
6
+ metadata.gz: '06298b0173f747cb598817a3be4b2567295c5fe2bfd40bb61d766e439dfdc823e7088268fbebc379af78a6bbedb484e1286f8d4cbc9c7cad5b9789d3a51bf15b'
7
+ data.tar.gz: 5a7bdc9dd72588e591b0c9f0401c9ecf55dc026a675cb81ee08b6e9af6fb5cb603f1828309a2fe5152d496b3d5284948b06f2ddb8365a8a2fe0ebd9ac254c804
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-apigee_v1
2
2
 
3
+ ### v0.26.0 (2021-11-03)
4
+
5
+ * Regenerated from discovery document revision 20211101
6
+
3
7
  ### v0.25.0 (2021-10-26)
4
8
 
5
9
  * Regenerated from discovery document revision 20211021
@@ -2859,16 +2859,16 @@ module Google
2859
2859
  end
2860
2860
  end
2861
2861
 
2862
- # This message type encapsulates a metric grouped by dimension.
2862
+ # Encapsulates a metric grouped by dimension.
2863
2863
  class GoogleCloudApigeeV1DimensionMetric
2864
2864
  include Google::Apis::Core::Hashable
2865
2865
 
2866
- # This field contains a list of metrics.
2866
+ # List of metrics.
2867
2867
  # Corresponds to the JSON property `metrics`
2868
2868
  # @return [Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metric>]
2869
2869
  attr_accessor :metrics
2870
2870
 
2871
- # This field contains the name of the dimension.
2871
+ # Name of the dimension.
2872
2872
  # Corresponds to the JSON property `name`
2873
2873
  # @return [String]
2874
2874
  attr_accessor :name
@@ -4647,7 +4647,7 @@ module Google
4647
4647
  end
4648
4648
  end
4649
4649
 
4650
- # This message type encapsulates additional information about query execution.
4650
+ # Encapsulates additional information about query execution.
4651
4651
  class GoogleCloudApigeeV1Metadata
4652
4652
  include Google::Apis::Core::Hashable
4653
4653
 
@@ -4656,10 +4656,10 @@ module Google
4656
4656
  # @return [Array<String>]
4657
4657
  attr_accessor :errors
4658
4658
 
4659
- # List of additional information such as data source, if result was truncated
4660
- # etc. E.g "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", "
4661
- # query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api.
4662
- # uapgroup2.agg_api" ]
4659
+ # List of additional information such as data source, if result was truncated.
4660
+ # For example: ``` "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.
4661
+ # apigeeks.net", "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table
4662
+ # used: edge.api.uapgroup2.agg_api" ]```
4663
4663
  # Corresponds to the JSON property `notices`
4664
4664
  # @return [Array<String>]
4665
4665
  attr_accessor :notices
@@ -4675,20 +4675,20 @@ module Google
4675
4675
  end
4676
4676
  end
4677
4677
 
4678
- # This message type encapsulates the metric data point. Example: ` "name": "sum(
4678
+ # Encapsulates the metric data point. For example: ```` "name": "sum(
4679
4679
  # message_count)", "values" : [ ` "timestamp": 1549004400000, "value": "39.0" `,
4680
- # ` "timestamp" : 1548997200000, "value" : "0.0" ` ] ` or ` "name": "sum(
4681
- # message_count)", "values" : ["39.0"] `
4680
+ # ` "timestamp" : 1548997200000, "value" : "0.0" ` ] ```` or ```` "name": "sum(
4681
+ # message_count)", "values" : ["39.0"] ````
4682
4682
  class GoogleCloudApigeeV1Metric
4683
4683
  include Google::Apis::Core::Hashable
4684
4684
 
4685
- # This field contains the metric name.
4685
+ # Metric name.
4686
4686
  # Corresponds to the JSON property `name`
4687
4687
  # @return [String]
4688
4688
  attr_accessor :name
4689
4689
 
4690
- # List of metric values. Possible value format: "values":["39.0"] or "values":[ `
4691
- # "value": "39.0", "timestamp": 1232434354` ]
4690
+ # List of metric values. Possible value formats include: `"values":["39.0"]` or `
4691
+ # "values":[ ` "value": "39.0", "timestamp": 1232434354` ]`
4692
4692
  # Corresponds to the JSON property `values`
4693
4693
  # @return [Array<Object>]
4694
4694
  attr_accessor :values
@@ -4937,7 +4937,7 @@ module Google
4937
4937
  class GoogleCloudApigeeV1OptimizedStats
4938
4938
  include Google::Apis::Core::Hashable
4939
4939
 
4940
- # This message type encapsulates a response format for Js Optimized Scenario.
4940
+ # Encapsulates a response format for JavaScript Optimized Scenario.
4941
4941
  # Corresponds to the JSON property `Response`
4942
4942
  # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStatsResponse]
4943
4943
  attr_accessor :response
@@ -4952,11 +4952,11 @@ module Google
4952
4952
  end
4953
4953
  end
4954
4954
 
4955
- # This message type encapsulates a data node as represented below: ` "identifier"
4956
- # : ` "names": [ "apiproxy" ], "values": [ "sirjee" ] `, "metric": [ ` "env": "
4957
- # prod", "name": "sum(message_count)", "values": [ 36.0 ] ` ] ` OR ` "env": "
4958
- # prod", "name": "sum(message_count)", "values": [ 36.0 ] ` Depending on whether
4959
- # a dimension is present in the query or not the data node type can be a simple
4955
+ # Encapsulates a data node as represented below: ``` ` "identifier": ` "names": [
4956
+ # "apiproxy" ], "values": [ "sirjee" ] `, "metric": [ ` "env": "prod", "name": "
4957
+ # sum(message_count)", "values": [ 36.0 ] ` ] ```` or ``` ` "env": "prod", "name"
4958
+ # : "sum(message_count)", "values": [ 36.0 ] ```` Depending on whether a
4959
+ # dimension is present in the query or not the data node type can be a simple
4960
4960
  # metric value or dimension identifier with list of metrics.
4961
4961
  class GoogleCloudApigeeV1OptimizedStatsNode
4962
4962
  include Google::Apis::Core::Hashable
@@ -4976,33 +4976,32 @@ module Google
4976
4976
  end
4977
4977
  end
4978
4978
 
4979
- # This message type encapsulates a response format for Js Optimized Scenario.
4979
+ # Encapsulates a response format for JavaScript Optimized Scenario.
4980
4980
  class GoogleCloudApigeeV1OptimizedStatsResponse
4981
4981
  include Google::Apis::Core::Hashable
4982
4982
 
4983
- # This field contains a list of time unit values. Time unit refers to an epoch
4984
- # timestamp value.
4983
+ # List of time unit values. Time unit refers to an epoch timestamp value.
4985
4984
  # Corresponds to the JSON property `TimeUnit`
4986
4985
  # @return [Array<Fixnum>]
4987
4986
  attr_accessor :time_unit
4988
4987
 
4989
- # This message type encapsulates additional information about query execution.
4988
+ # Encapsulates additional information about query execution.
4990
4989
  # Corresponds to the JSON property `metaData`
4991
4990
  # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metadata]
4992
4991
  attr_accessor :meta_data
4993
4992
 
4994
- # This ia a boolean field to indicate if the results were truncated based on the
4993
+ # Boolean flag that indicates whether the results were truncated based on the
4995
4994
  # limit parameter.
4996
4995
  # Corresponds to the JSON property `resultTruncated`
4997
4996
  # @return [Boolean]
4998
4997
  attr_accessor :result_truncated
4999
4998
  alias_method :result_truncated?, :result_truncated
5000
4999
 
5001
- # This message type encapsulates a data node as represented below: ` "identifier"
5002
- # : ` "names": [ "apiproxy" ], "values": [ "sirjee" ] `, "metric": [ ` "env": "
5003
- # prod", "name": "sum(message_count)", "values": [ 36.0 ] ` ] ` OR ` "env": "
5004
- # prod", "name": "sum(message_count)", "values": [ 36.0 ] ` Depending on whether
5005
- # a dimension is present in the query or not the data node type can be a simple
5000
+ # Encapsulates a data node as represented below: ``` ` "identifier": ` "names": [
5001
+ # "apiproxy" ], "values": [ "sirjee" ] `, "metric": [ ` "env": "prod", "name": "
5002
+ # sum(message_count)", "values": [ 36.0 ] ` ] ```` or ``` ` "env": "prod", "name"
5003
+ # : "sum(message_count)", "values": [ 36.0 ] ```` Depending on whether a
5004
+ # dimension is present in the query or not the data node type can be a simple
5006
5005
  # metric value or dimension identifier with list of metrics.
5007
5006
  # Corresponds to the JSON property `stats`
5008
5007
  # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStatsNode]
@@ -6777,21 +6776,21 @@ module Google
6777
6776
  end
6778
6777
  end
6779
6778
 
6780
- # This message type encapsulates a stats response.
6779
+ # Encapsulates a `stats` response.
6781
6780
  class GoogleCloudApigeeV1Stats
6782
6781
  include Google::Apis::Core::Hashable
6783
6782
 
6784
- # This field contains a list of query results on environment level.
6783
+ # List of query results on the environment level.
6785
6784
  # Corresponds to the JSON property `environments`
6786
6785
  # @return [Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1StatsEnvironmentStats>]
6787
6786
  attr_accessor :environments
6788
6787
 
6789
- # This field contains a list of query results grouped by host.
6788
+ # List of query results grouped by host.
6790
6789
  # Corresponds to the JSON property `hosts`
6791
6790
  # @return [Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1StatsHostStats>]
6792
6791
  attr_accessor :hosts
6793
6792
 
6794
- # This message type encapsulates additional information about query execution.
6793
+ # Encapsulates additional information about query execution.
6795
6794
  # Corresponds to the JSON property `metaData`
6796
6795
  # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metadata]
6797
6796
  attr_accessor :meta_data
@@ -6808,31 +6807,31 @@ module Google
6808
6807
  end
6809
6808
  end
6810
6809
 
6811
- # This message type encapsulates the environment wrapper: "environments": [ ` "
6812
- # metrics": [ ` "name": "sum(message_count)", "values": [ "2.52056245E8" ] ` ], "
6813
- # name": "prod" ` ]
6810
+ # Encapsulates the environment wrapper: ``` "environments": [ ` "metrics": [ ` "
6811
+ # name": "sum(message_count)", "values": [ "2.52056245E8" ] ` ], "name": "prod" `
6812
+ # ]```
6814
6813
  class GoogleCloudApigeeV1StatsEnvironmentStats
6815
6814
  include Google::Apis::Core::Hashable
6816
6815
 
6817
- # This field contains the list of metrics grouped under dimensions.
6816
+ # List of metrics grouped under dimensions.
6818
6817
  # Corresponds to the JSON property `dimensions`
6819
6818
  # @return [Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1DimensionMetric>]
6820
6819
  attr_accessor :dimensions
6821
6820
 
6822
6821
  # In the final response, only one of the following fields will be present based
6823
- # on the dimensions provided. If no dimensions are provided, then only a top
6824
- # level metrics is provided. If dimensions are included, then there will be a
6825
- # top level dimensions field under environments which will contain metrics
6826
- # values and the dimension name. Example: "environments": [ ` "dimensions": [ ` "
6822
+ # on the dimensions provided. If no dimensions are provided, then only top-level
6823
+ # metrics is provided. If dimensions are included, then there will be a top-
6824
+ # level dimensions field under environments which will contain metrics values
6825
+ # and the dimension name. Example: ``` "environments": [ ` "dimensions": [ ` "
6827
6826
  # metrics": [ ` "name": "sum(message_count)", "values": [ "2.14049521E8" ] ` ], "
6828
- # name": "nit_proxy" ` ], "name": "prod" ` ] OR "environments": [ ` "metrics": [
6829
- # ` "name": "sum(message_count)", "values": [ "2.19026331E8" ] ` ], "name": "
6830
- # prod" ` ] This field contains the list of metric values.
6827
+ # name": "nit_proxy" ` ], "name": "prod" ` ]``` or ```"environments": [ ` "
6828
+ # metrics": [ ` "name": "sum(message_count)", "values": [ "2.19026331E8" ] ` ], "
6829
+ # name": "prod" ` ]``` List of metric values.
6831
6830
  # Corresponds to the JSON property `metrics`
6832
6831
  # @return [Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metric>]
6833
6832
  attr_accessor :metrics
6834
6833
 
6835
- #
6834
+ # Name of the environment.
6836
6835
  # Corresponds to the JSON property `name`
6837
6836
  # @return [String]
6838
6837
  attr_accessor :name
@@ -6849,31 +6848,31 @@ module Google
6849
6848
  end
6850
6849
  end
6851
6850
 
6852
- # This message type encapsulates the hostname wrapper: "hosts": [ ` "metrics": [
6853
- # ` "name": "sum(message_count)", "values": [ "2.52056245E8" ] ` ], "name": "
6854
- # example.com" ` ]
6851
+ # Encapsulates the hostname wrapper: ``` "hosts": [ ` "metrics": [ ` "name": "
6852
+ # sum(message_count)", "values": [ "2.52056245E8" ] ` ], "name": "example.com" `
6853
+ # ]```
6855
6854
  class GoogleCloudApigeeV1StatsHostStats
6856
6855
  include Google::Apis::Core::Hashable
6857
6856
 
6858
- # This field contains the list of metrics grouped under dimensions.
6857
+ # List of metrics grouped under dimensions.
6859
6858
  # Corresponds to the JSON property `dimensions`
6860
6859
  # @return [Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1DimensionMetric>]
6861
6860
  attr_accessor :dimensions
6862
6861
 
6863
6862
  # In the final response, only one of the following fields will be present based
6864
- # on the dimensions provided. If no dimensions are provided, then only a top
6865
- # level metrics is provided. If dimensions are included, then there will be a
6866
- # top level dimensions field under hostnames which will contain metrics values
6867
- # and the dimension name. Example: "hosts": [ ` "dimensions": [ ` "metrics": [ `
6868
- # "name": "sum(message_count)", "values": [ "2.14049521E8" ] ` ], "name": "
6869
- # nit_proxy" ` ], "name": "example.com" ` ] OR "hosts": [ ` "metrics": [ ` "name"
6870
- # : "sum(message_count)", "values": [ "2.19026331E8" ] ` ], "name": "example.com"
6871
- # ` ] This field contains the list of metric values.
6863
+ # on the dimensions provided. If no dimensions are provided, then only the top-
6864
+ # level metrics are provided. If dimensions are included, then there will be a
6865
+ # top-level dimensions field under hostnames which will contain metrics values
6866
+ # and the dimension name. Example: ``` "hosts": [ ` "dimensions": [ ` "metrics":
6867
+ # [ ` "name": "sum(message_count)", "values": [ "2.14049521E8" ] ` ], "name": "
6868
+ # nit_proxy" ` ], "name": "example.com" ` ]``` OR ```"hosts": [ ` "metrics": [ `
6869
+ # "name": "sum(message_count)", "values": [ "2.19026331E8" ] ` ], "name": "
6870
+ # example.com" ` ]``` List of metric values.
6872
6871
  # Corresponds to the JSON property `metrics`
6873
6872
  # @return [Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metric>]
6874
6873
  attr_accessor :metrics
6875
6874
 
6876
- # This field contains the hostname used in query.
6875
+ # Hostname used in query.
6877
6876
  # Corresponds to the JSON property `name`
6878
6877
  # @return [String]
6879
6878
  attr_accessor :name
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module ApigeeV1
18
18
  # Version of the google-apis-apigee_v1 gem
19
- GEM_VERSION = "0.25.0"
19
+ GEM_VERSION = "0.26.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20211021"
25
+ REVISION = "20211101"
26
26
  end
27
27
  end
28
28
  end
@@ -5685,58 +5685,55 @@ module Google
5685
5685
  execute_or_queue_command(command, &block)
5686
5686
  end
5687
5687
 
5688
- # This api is similar to GetStats except that the response is less verbose. In
5689
- # the current scheme, a query parameter _optimized instructs Edge Analytics to
5690
- # change the response but since this behavior is not possible with protocol
5691
- # buffer and since this parameter is predominantly used by Edge UI, we are
5692
- # introducing a separate api.
5693
- # @param [String] name
5694
- # Required. The resource name for which the interactive query will be executed.
5695
- # Must be of the form `organizations/`organization_id`/environments/`
5696
- # environment_id/optimizedStats/`dimensions`` Dimensions let you view metrics in
5697
- # meaningful groupings. E.g. apiproxy, target_host. The value of dimensions
5698
- # should be comma separated list as shown below `organizations/`org`/
5699
- # environments/`env`/optimizedStats/apiproxy,request_verb`
5688
+ # Similar to GetStats except that the response is less verbose.
5689
+ # @param [String] name
5690
+ # Required. Resource name for which the interactive query will be executed. Use
5691
+ # the following format in your request: `organizations/`org`/environments/`env`/
5692
+ # optimizedStats/`dimensions`` Dimensions let you view metrics in meaningful
5693
+ # groupings, such as `apiproxy`, `target_host`. The value of `dimensions` should
5694
+ # be a comma-separated list as shown below: `organizations/`org`/environments/`
5695
+ # env`/optimizedStats/apiproxy,request_verb`
5700
5696
  # @param [String] accuracy
5701
- # Legacy field: not used anymore.
5697
+ # No longer used by Apigee. Supported for backwards compatibility.
5702
5698
  # @param [String] agg_table
5703
- # If customers want to query custom aggregate tables, then this parameter can be
5704
- # used to specify the table name. If this parameter is skipped, then Edge Query
5705
- # will try to retrieve the data from fact tables which will be expensive.
5699
+ # Table name used to query custom aggregate tables. If this parameter is skipped,
5700
+ # then Apigee will try to retrieve the data from fact tables which will be
5701
+ # expensive.
5706
5702
  # @param [String] filter
5707
- # Enables drill-down on specific dimension values.
5703
+ # Filter that enables you to drill-down on specific dimension values.
5708
5704
  # @param [String] limit
5709
- # This parameter is used to limit the number of result items. Default and the
5710
- # max value is 14400.
5705
+ # Maximum number of result items to return. The default and maximum value that
5706
+ # can be returned is 14400.
5711
5707
  # @param [String] offset
5712
- # Use offset with limit to enable pagination of results. For example, to display
5713
- # results 11-20, set limit to '10' and offset to '10'.
5708
+ # Offset value. Use `offset` with `limit` to enable pagination of results. For
5709
+ # example, to display results 11-20, set limit to `10` and offset to `10`.
5714
5710
  # @param [Boolean] realtime
5715
- # Legacy field: not used anymore.
5711
+ # No longer used by Apigee. Supported for backwards compatibility.
5716
5712
  # @param [String] select
5717
- # Required. The select parameter contains a comma separated list of metrics. E.g.
5718
- # sum(message_count),sum(error_count)
5713
+ # Required. Comma-separated list of metrics. For example: `sum(message_count),
5714
+ # sum(error_count)`
5719
5715
  # @param [Boolean] sonar
5720
- # This parameter routes the query to api monitoring service for last hour.
5716
+ # Routes the query to API Monitoring for the last hour.
5721
5717
  # @param [String] sort
5722
- # This parameter specifies if the sort order should be ascending or descending
5723
- # Supported values are DESC and ASC.
5718
+ # Flag that specifies whether the sort order should be ascending or descending.
5719
+ # Valid values include `DESC` and `ASC`.
5724
5720
  # @param [String] sortby
5725
- # Comma separated list of columns to sort the final result.
5721
+ # Comma-separated list of columns to sort the final result.
5726
5722
  # @param [String] time_range
5727
- # Required. Time interval for the interactive query. Time range is specified as
5728
- # start~end E.g. 04/15/2017 00:00~05/15/2017 23:59
5723
+ # Required. Time interval for the interactive query. Time range is specified in
5724
+ # GMT as `start~end`. For example: `04/15/2017 00:00~05/15/2017 23:59`
5729
5725
  # @param [String] time_unit
5730
- # A value of second, minute, hour, day, week, month. Time Unit specifies the
5731
- # granularity of metrics returned.
5726
+ # Granularity of metrics returned. Valid values include: `second`, `minute`, `
5727
+ # hour`, `day`, `week`, or `month`.
5732
5728
  # @param [String] topk
5733
- # Take 'top k' results from results, for example, to return the top 5 results '
5734
- # topk=5'.
5729
+ # Top number of results to return. For example, to return the top 5 results, set
5730
+ # `topk=5`.
5735
5731
  # @param [Boolean] ts_ascending
5736
- # Lists timestamps in ascending order if set to true. Recommend setting this
5737
- # value to true if you are using sortby with sort=DESC.
5732
+ # Flag that specifies whether to list timestamps in ascending (`true`) or
5733
+ # descending (`false`) order. Apigee recommends setting this value to `true` if
5734
+ # you are using `sortby` with `sort=DESC`.
5738
5735
  # @param [String] tzo
5739
- # This parameters contains the timezone offset value.
5736
+ # Timezone offset value.
5740
5737
  # @param [String] fields
5741
5738
  # Selector specifying which fields to include in a partial response.
5742
5739
  # @param [String] quota_user
@@ -6464,58 +6461,58 @@ module Google
6464
6461
 
6465
6462
  # Retrieve metrics grouped by dimensions. The types of metrics you can retrieve
6466
6463
  # include traffic, message counts, API call latency, response size, and cache
6467
- # hits and counts. Dimensions let you view metrics in meaningful groups. The
6468
- # stats api does accept dimensions as path params. The dimensions are optional
6469
- # in which case the metrics are computed on the entire data for the given
6470
- # timerange.
6471
- # @param [String] name
6472
- # Required. The resource name for which the interactive query will be executed.
6473
- # Must be of the form `organizations/`organization_id`/environments/`
6474
- # environment_id/stats/`dimensions`` Dimensions let you view metrics in
6475
- # meaningful groupings. E.g. apiproxy, target_host. The value of dimensions
6476
- # should be comma separated list as shown below `organizations/`org`/
6477
- # environments/`env`/stats/apiproxy,request_verb`
6464
+ # hits and counts. Dimensions let you view metrics in meaningful groups. You can
6465
+ # optionally pass dimensions as path parameters to the `stats` API. If
6466
+ # dimensions are not specified, the metrics are computed on the entire set of
6467
+ # data for the given time range.
6468
+ # @param [String] name
6469
+ # Required. Resource name for which the interactive query will be executed. Use
6470
+ # the following format in your request: `organizations/`org`/environments/`env`/
6471
+ # stats/`dimensions`` Dimensions let you view metrics in meaningful groupings,
6472
+ # such as `apiproxy` or `target_host`. The value of dimensions should be a comma-
6473
+ # separated list, as shown below: `organizations/`org`/environments/`env`/stats/
6474
+ # apiproxy,request_verb`
6478
6475
  # @param [String] accuracy
6479
- # Legacy field: not used anymore. This field is present to support UI calls
6480
- # which still use this parameter.
6476
+ # No longer used by Apigee. Supported for backwards compatibility.
6481
6477
  # @param [String] agg_table
6482
- # If customers want to query custom aggregate tables, then this parameter can be
6483
- # used to specify the table name. If this parameter is skipped, then Edge Query
6484
- # will try to retrieve the data from fact tables which will be expensive.
6478
+ # Table name used to query custom aggregate tables. If this parameter is skipped,
6479
+ # then Apigee will try to retrieve the data from fact tables which will be
6480
+ # expensive.
6485
6481
  # @param [String] filter
6486
- # Enables drill-down on specific dimension values
6482
+ # Filter that enables you to drill down on specific dimension values.
6487
6483
  # @param [String] limit
6488
- # This parameter is used to limit the number of result items. Default and the
6489
- # max value is 14400.
6484
+ # Maximum number of result items to return. The default and maximum value that
6485
+ # can be returned is 14400.
6490
6486
  # @param [String] offset
6491
- # Use offset with limit to enable pagination of results. For example, to display
6492
- # results 11-20, set limit to '10' and offset to '10'.
6487
+ # Offset value. Use `offset` with `limit` to enable pagination of results. For
6488
+ # example, to display results 11-20, set limit to `10` and offset to `10`.
6493
6489
  # @param [Boolean] realtime
6494
- # Legacy field: not used anymore.
6490
+ # No longer used by Apigee. Supported for backwards compatibility.
6495
6491
  # @param [String] select
6496
- # The select parameter contains a comma separated list of metrics. E.g. sum(
6497
- # message_count),sum(error_count)
6492
+ # Comma-separated list of metrics. For example: `sum(message_count),sum(
6493
+ # error_count)`
6498
6494
  # @param [Boolean] sonar
6499
- # This parameter routes the query to api monitoring service for last hour.
6495
+ # Routes the query to API Monitoring for the last hour.
6500
6496
  # @param [String] sort
6501
- # This parameter specifies if the sort order should be ascending or descending
6502
- # Supported values are DESC and ASC.
6497
+ # Flag that specifies whether the sort order should be ascending or descending.
6498
+ # Valid values include: `DESC` and `ASC`.
6503
6499
  # @param [String] sortby
6504
- # Comma separated list of columns to sort the final result.
6500
+ # Comma-separated list of columns to sort the final result.
6505
6501
  # @param [String] time_range
6506
- # Time interval for the interactive query. Time range is specified as start~end
6507
- # E.g. 04/15/2017 00:00~05/15/2017 23:59
6502
+ # Time interval for the interactive query. Time range is specified in GMT as `
6503
+ # start~end`. For example: `04/15/2017 00:00~05/15/2017 23:59`
6508
6504
  # @param [String] time_unit
6509
- # A value of second, minute, hour, day, week, month. Time Unit specifies the
6510
- # granularity of metrics returned.
6505
+ # Granularity of metrics returned. Valid values include: `second`, `minute`, `
6506
+ # hour`, `day`, `week`, or` month`.
6511
6507
  # @param [String] topk
6512
- # Take 'top k' results from results, for example, to return the top 5 results '
6513
- # topk=5'.
6508
+ # Top number of results to return. For example, to return the top 5 results, set
6509
+ # `topk=5`.
6514
6510
  # @param [Boolean] ts_ascending
6515
- # Lists timestamps in ascending order if set to true. Recommend setting this
6516
- # value to true if you are using sortby with sort=DESC.
6511
+ # Flag that specifies whether to list timestamps in ascending (`true`) or
6512
+ # descending (`false`) order. Apigee recommends that you set this value to `true`
6513
+ # if you are using `sortby` with `sort=DESC`.
6517
6514
  # @param [String] tzo
6518
- # This parameters contains the timezone offset value.
6515
+ # Timezone offset value.
6519
6516
  # @param [String] fields
6520
6517
  # Selector specifying which fields to include in a partial response.
6521
6518
  # @param [String] quota_user
@@ -7070,51 +7067,52 @@ module Google
7070
7067
  # Retrieve metrics grouped by dimensions in host level. The types of metrics you
7071
7068
  # can retrieve include traffic, message counts, API call latency, response size,
7072
7069
  # and cache hits and counts. Dimensions let you view metrics in meaningful
7073
- # groups. The stats api does accept dimensions as path params. The dimensions
7074
- # are optional in which case the metrics are computed on the entire data for the
7075
- # given timerange.
7076
- # @param [String] name
7077
- # Required. The resource name for which the interactive query will be executed.
7078
- # Must be of the form `organizations/`organization_id`/hostStats/`dimensions``.
7079
- # Dimensions let you view metrics in meaningful groupings. E.g. apiproxy,
7080
- # target_host. The value of dimensions should be comma separated list as shown
7081
- # below `organizations/`org`/hostStats/apiproxy,request_verb`
7070
+ # groups. You can optionally pass dimensions as path parameters to the `stats`
7071
+ # API. If dimensions are not specified, the metrics are computed on the entire
7072
+ # set of data for the given time range.
7073
+ # @param [String] name
7074
+ # Required. Resource name for which the interactive query will be executed. Use
7075
+ # the following format in your request: `organizations/`org`/hostStats/`
7076
+ # dimensions`` Dimensions let you view metrics in meaningful groupings, such as `
7077
+ # apiproxy`, `target_host`. The value of dimensions should be a comma-separated
7078
+ # list as shown below `organizations/`org`/hostStats/apiproxy,request_verb`
7082
7079
  # @param [String] accuracy
7083
- # Legacy field: not used anymore.
7080
+ # No longer used by Apigee. Supported for backwards compatibility.
7084
7081
  # @param [String] envgroup_hostname
7085
- # Required. The hostname for which the interactive query will be executed.
7082
+ # Required. Hostname for which the interactive query will be executed.
7086
7083
  # @param [String] filter
7087
- # Enables drill-down on specific dimension values.
7084
+ # Flag that enables drill-down on specific dimension values.
7088
7085
  # @param [String] limit
7089
- # This parameter is used to limit the number of result items. Default and the
7090
- # max value is 14400.
7086
+ # Maximum number of result items to return. The default and maximum value that
7087
+ # can be returned is 14400.
7091
7088
  # @param [String] offset
7092
- # Use offset with limit to enable pagination of results. For example, to display
7093
- # results 11-20, set limit to '10' and offset to '10'.
7089
+ # Offset value. Use `offset` with `limit` to enable pagination of results. For
7090
+ # example, to display results 11-20, set limit to `10` and offset to `10`.
7094
7091
  # @param [Boolean] realtime
7095
- # Legacy field: not used anymore.
7092
+ # No longer used by Apigee. Supported for backwards compatibility.
7096
7093
  # @param [String] select
7097
- # The select parameter contains a comma separated list of metrics. E.g. sum(
7098
- # message_count),sum(error_count)
7094
+ # Comma-separated list of metrics. For example: `sum(message_count),sum(
7095
+ # error_count)`
7099
7096
  # @param [String] sort
7100
- # This parameter specifies if the sort order should be ascending or descending
7101
- # Supported values are DESC and ASC.
7097
+ # Flag that specifies if the sort order should be ascending or descending. Valid
7098
+ # values are `DESC` and `ASC`.
7102
7099
  # @param [String] sortby
7103
- # Comma separated list of columns to sort the final result.
7100
+ # Comma-separated list of columns to sort the final result.
7104
7101
  # @param [String] time_range
7105
- # Time interval for the interactive query. Time range is specified as start~end
7106
- # E.g. 04/15/2017 00:00~05/15/2017 23:59
7102
+ # Time interval for the interactive query. Time range is specified in GMT as `
7103
+ # start~end`. For example: `04/15/2017 00:00~05/15/2017 23:59`
7107
7104
  # @param [String] time_unit
7108
- # A value of second, minute, hour, day, week, month. Time Unit specifies the
7109
- # granularity of metrics returned.
7105
+ # Granularity of metrics returned. Valid values include: `second`, `minute`, `
7106
+ # hour`, `day`, `week`, or `month`.
7110
7107
  # @param [String] topk
7111
- # Take 'top k' results from results, for example, to return the top 5 results '
7112
- # topk=5'.
7108
+ # Top number of results to return. For example, to return the top 5 results, set
7109
+ # `topk=5`.
7113
7110
  # @param [Boolean] ts_ascending
7114
- # Lists timestamps in ascending order if set to true. Recommend setting this
7115
- # value to true if you are using sortby with sort=DESC.
7111
+ # Flag that specifies whether to list timestamps in ascending (`true`) or
7112
+ # descending (`false`) order. Apigee recommends that you set this value to `true`
7113
+ # if you are using `sortby` with `sort=DESC`.
7116
7114
  # @param [String] tzo
7117
- # This parameters contains the timezone offset value.
7115
+ # Timezone offset value.
7118
7116
  # @param [String] fields
7119
7117
  # Selector specifying which fields to include in a partial response.
7120
7118
  # @param [String] quota_user
@@ -7887,49 +7885,51 @@ module Google
7887
7885
  execute_or_queue_command(command, &block)
7888
7886
  end
7889
7887
 
7890
- # This api is similar to GetHostStats except that the response is less verbose.
7888
+ # Similar to GetHostStats except that the response is less verbose.
7891
7889
  # @param [String] name
7892
- # Required. The resource name for which the interactive query will be executed.
7893
- # Must be of the form `organizations/`organization_id`/optimizedHostStats/`
7894
- # dimensions``. Dimensions let you view metrics in meaningful groupings. E.g.
7895
- # apiproxy, target_host. The value of dimensions should be comma separated list
7896
- # as shown below `organizations/`org`/optimizedHostStats/apiproxy,request_verb`
7890
+ # Required. Resource name for which the interactive query will be executed. Use
7891
+ # the following format in your request: `organizations/`organization_id`/
7892
+ # optimizedHostStats/`dimensions`` Dimensions let you view metrics in meaningful
7893
+ # groupings, such as `apiproxy`, `target_host`. The value of dimensions should
7894
+ # be a comma-separated list as shown below: `organizations/`org`/
7895
+ # optimizedHostStats/apiproxy,request_verb`
7897
7896
  # @param [String] accuracy
7898
- # Legacy field: not used anymore.
7897
+ # No longer used by Apigee. Supported for backwards compatibility.
7899
7898
  # @param [String] envgroup_hostname
7900
- # Required. The hostname for which the interactive query will be executed.
7899
+ # Required. Hostname for which the interactive query will be executed.
7901
7900
  # @param [String] filter
7902
- # Enables drill-down on specific dimension values.
7901
+ # Filter that enables you to drill-down on specific dimension values.
7903
7902
  # @param [String] limit
7904
- # This parameter is used to limit the number of result items. Default and the
7905
- # max value is 14400.
7903
+ # Maximum number of result items to return. The default and maximum value that
7904
+ # can be returned is 14400.
7906
7905
  # @param [String] offset
7907
- # Use offset with limit to enable pagination of results. For example, to display
7908
- # results 11-20, set limit to '10' and offset to '10'.
7906
+ # Offset value. Use `offset` with `limit` to enable pagination of results. For
7907
+ # example, to display results 11-20, set limit to `10` and offset to `10`.
7909
7908
  # @param [Boolean] realtime
7910
- # Legacy field: not used anymore.
7909
+ # No longer used by Apigee. Supported for backwards compatibility.
7911
7910
  # @param [String] select
7912
- # Required. The select parameter contains a comma separated list of metrics. E.g.
7913
- # sum(message_count),sum(error_count)
7911
+ # Required. Comma-separated list of metrics. For example: `sum(message_count),
7912
+ # sum(error_count)`
7914
7913
  # @param [String] sort
7915
- # This parameter specifies if the sort order should be ascending or descending
7916
- # Supported values are DESC and ASC.
7914
+ # Flag that specifies whether the sort order should be ascending or descending.
7915
+ # Valid values include `DESC` and `ASC`.
7917
7916
  # @param [String] sortby
7918
- # Comma separated list of columns to sort the final result.
7917
+ # Comma-separated list of columns used to sort the final result.
7919
7918
  # @param [String] time_range
7920
- # Required. Time interval for the interactive query. Time range is specified as
7921
- # start~end. E.g 04/15/2017 00:00~05/15/2017 23:59.
7919
+ # Required. Time interval for the interactive query. Time range is specified in
7920
+ # GMT as `start~end`. For example: `04/15/2017 00:00~05/15/2017 23:59`.
7922
7921
  # @param [String] time_unit
7923
- # A value of second, minute, hour, day, week, month. Time Unit specifies the
7924
- # granularity of metrics returned.
7922
+ # Granularity of metrics returned. Valid values include: `second`, `minute`, `
7923
+ # hour`, `day`, `week`, or `month`.
7925
7924
  # @param [String] topk
7926
- # Take 'top k' results from results, for example, to return the top 5 results '
7927
- # topk=5'.
7925
+ # Top number of results to return. For example, to return the top 5 results, set
7926
+ # `topk=5`.
7928
7927
  # @param [Boolean] ts_ascending
7929
- # Lists timestamps in ascending order if set to true. Recommend setting this
7930
- # value to true if you are using sortby with sort=DESC.
7928
+ # Flag that specifies whether to list timestamps in ascending (`true`) or
7929
+ # descending (`false`) order. Apigee recommends that you set this value to `true`
7930
+ # if you are using `sortby` with `sort=DESC`.
7931
7931
  # @param [String] tzo
7932
- # This parameters contains the timezone offset value.
7932
+ # Timezone offset value.
7933
7933
  # @param [String] fields
7934
7934
  # Selector specifying which fields to include in a partial response.
7935
7935
  # @param [String] quota_user
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-apigee_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.25.0
4
+ version: 0.26.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-10-27 00:00:00.000000000 Z
11
+ date: 2021-11-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-apigee_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-apigee_v1/v0.25.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-apigee_v1/v0.26.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-apigee_v1
63
63
  post_install_message:
64
64
  rdoc_options: []