From 1d5ea0451b362944837f482d611a650a70932596 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 12 Mar 2024 07:08:24 +0000 Subject: [PATCH] feat(cloudbilling): update the api #### cloudbilling:v1beta The following keys were added: - resources.billingAccounts.resources.anomalies.methods.get (Total Keys: 11) - resources.billingAccounts.resources.anomalies.methods.list (Total Keys: 18) - resources.projects.resources.anomalies.methods.get (Total Keys: 11) - resources.projects.resources.anomalies.methods.list (Total Keys: 18) - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly (Total Keys: 21) - schemas.GoogleCloudBillingAnomaliesV1betaCause (Total Keys: 8) - schemas.GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse (Total Keys: 5) --- ...ling_v1beta.billingAccounts.anomalies.html | 257 +++++++++++++++ .../cloudbilling_v1beta.billingAccounts.html | 5 + docs/dyn/cloudbilling_v1beta.html | 5 + ...loudbilling_v1beta.projects.anomalies.html | 257 +++++++++++++++ docs/dyn/cloudbilling_v1beta.projects.html | 91 ++++++ .../documents/cloudbilling.v1.json | 2 +- .../documents/cloudbilling.v1beta.json | 305 +++++++++++++++++- 7 files changed, 920 insertions(+), 2 deletions(-) create mode 100644 docs/dyn/cloudbilling_v1beta.billingAccounts.anomalies.html create mode 100644 docs/dyn/cloudbilling_v1beta.projects.anomalies.html create mode 100644 docs/dyn/cloudbilling_v1beta.projects.html diff --git a/docs/dyn/cloudbilling_v1beta.billingAccounts.anomalies.html b/docs/dyn/cloudbilling_v1beta.billingAccounts.anomalies.html new file mode 100644 index 00000000000..aa78d2062dc --- /dev/null +++ b/docs/dyn/cloudbilling_v1beta.billingAccounts.anomalies.html @@ -0,0 +1,257 @@ + + + +

Cloud Billing API . billingAccounts . anomalies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets an anomaly for a billing account or a project.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists anomalies for a billing account or a project.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) + 
Gets an anomaly for a billing account or a project.
+
+Args:
+  name: string, Required. Format for project: projects/{project}/anomalies/{anomalies}. Format for billing account: billingAccounts/{billing_account}/anomalies/{anomalies}. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Encapsulates an anomaly.
+  "detectionTime": "A String", # Time that the anomaly was detected. Will be set to 00:00 google time of the detected date.
+  "deviation": { # Encapsulates the deviation information. # Deviation information of the anomaly.
+    "actualSpend": { # Represents an amount of money with its currency type. # The actual spend for the anomaly.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "deviationAmount": { # Represents an amount of money with its currency type. # The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "deviationPercentage": 3.14, # The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.
+    "expectedSpend": { # Represents an amount of money with its currency type. # The expected spend for the anomaly.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+  },
+  "name": "A String", # Identifier. Resource name for the anomaly.
+  "resourceDisplayName": "A String", # The display name of the resource that the anomaly occurred in/belongs to.
+  "rootCauses": [ # A list of causes which contribute to the anomaly.
+    { # Encapsulates the information of the reason which caused the anomaly.
+      "causeType": "A String", # The cause type.
+      "deviation": { # Encapsulates the deviation information. # The deviation information for the cause.
+        "actualSpend": { # Represents an amount of money with its currency type. # The actual spend for the anomaly.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "deviationAmount": { # Represents an amount of money with its currency type. # The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "deviationPercentage": 3.14, # The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.
+        "expectedSpend": { # Represents an amount of money with its currency type. # The expected spend for the anomaly.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+      },
+      "displayName": "A String", # The display name of the cause.
+      "resource": "A String", # The resource name of the cause. project: projects/{project}. service: services/{service}. sku: services/{service}/skus/{sku}.
+      "subCauses": [ # The sub causes.
+        # Object with schema name: GoogleCloudBillingAnomaliesV1betaCause
+      ],
+    },
+  ],
+  "scope": "A String", # Indicate the scope of the anomaly.
+  "severity": "A String", # Severity of the anomaly. Unspecified if severity is not met/assigned.
+  "updateTime": "A String", # Output only. The most recent anomaly's last updated time.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists anomalies for a billing account or a project.
+
+Args:
+  parent: string, Required. The project to list Anomaly for the project. Format for project: projects/{project}. Format for billing account: billingAccounts/{billing_account}. (required)
+  filter: string, Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days' anomalies. Examples: - start_time = "20231201" AND end_time = "20240120" .
+  pageSize: integer, Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000.
+  pageToken: string, Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListAnomalies.
+  "anomalies": [ # The returned anomalies.
+    { # Encapsulates an anomaly.
+      "detectionTime": "A String", # Time that the anomaly was detected. Will be set to 00:00 google time of the detected date.
+      "deviation": { # Encapsulates the deviation information. # Deviation information of the anomaly.
+        "actualSpend": { # Represents an amount of money with its currency type. # The actual spend for the anomaly.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "deviationAmount": { # Represents an amount of money with its currency type. # The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "deviationPercentage": 3.14, # The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.
+        "expectedSpend": { # Represents an amount of money with its currency type. # The expected spend for the anomaly.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+      },
+      "name": "A String", # Identifier. Resource name for the anomaly.
+      "resourceDisplayName": "A String", # The display name of the resource that the anomaly occurred in/belongs to.
+      "rootCauses": [ # A list of causes which contribute to the anomaly.
+        { # Encapsulates the information of the reason which caused the anomaly.
+          "causeType": "A String", # The cause type.
+          "deviation": { # Encapsulates the deviation information. # The deviation information for the cause.
+            "actualSpend": { # Represents an amount of money with its currency type. # The actual spend for the anomaly.
+              "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+              "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+              "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+            },
+            "deviationAmount": { # Represents an amount of money with its currency type. # The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend.
+              "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+              "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+              "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+            },
+            "deviationPercentage": 3.14, # The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.
+            "expectedSpend": { # Represents an amount of money with its currency type. # The expected spend for the anomaly.
+              "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+              "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+              "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+            },
+          },
+          "displayName": "A String", # The display name of the cause.
+          "resource": "A String", # The resource name of the cause. project: projects/{project}. service: services/{service}. sku: services/{service}/skus/{sku}.
+          "subCauses": [ # The sub causes.
+            # Object with schema name: GoogleCloudBillingAnomaliesV1betaCause
+          ],
+        },
+      ],
+      "scope": "A String", # Indicate the scope of the anomaly.
+      "severity": "A String", # Severity of the anomaly. Unspecified if severity is not met/assigned.
+      "updateTime": "A String", # Output only. The most recent anomaly's last updated time.
+    },
+  ],
+  "nextPageToken": "A String", # Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
+}
+
+ +
+ list_next() + 
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/cloudbilling_v1beta.billingAccounts.html b/docs/dyn/cloudbilling_v1beta.billingAccounts.html index 2a82bea9c08..0234ad9afbc 100644 --- a/docs/dyn/cloudbilling_v1beta.billingAccounts.html +++ b/docs/dyn/cloudbilling_v1beta.billingAccounts.html @@ -74,6 +74,11 @@

Cloud Billing API . billingAccounts

Instance Methods

+

+ anomalies() +

+

Returns the anomalies Resource.

+

services()

diff --git a/docs/dyn/cloudbilling_v1beta.html b/docs/dyn/cloudbilling_v1beta.html index e4525c23684..692fc98be91 100644 --- a/docs/dyn/cloudbilling_v1beta.html +++ b/docs/dyn/cloudbilling_v1beta.html @@ -79,6 +79,11 @@

Instance Methods

Returns the billingAccounts Resource.

+

+ projects() +

+

Returns the projects Resource.

+

skuGroups()

diff --git a/docs/dyn/cloudbilling_v1beta.projects.anomalies.html b/docs/dyn/cloudbilling_v1beta.projects.anomalies.html new file mode 100644 index 00000000000..2b6a8ca450b --- /dev/null +++ b/docs/dyn/cloudbilling_v1beta.projects.anomalies.html @@ -0,0 +1,257 @@ + + + +

Cloud Billing API . projects . anomalies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets an anomaly for a billing account or a project.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists anomalies for a billing account or a project.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) + 
Gets an anomaly for a billing account or a project.
+
+Args:
+  name: string, Required. Format for project: projects/{project}/anomalies/{anomalies}. Format for billing account: billingAccounts/{billing_account}/anomalies/{anomalies}. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Encapsulates an anomaly.
+  "detectionTime": "A String", # Time that the anomaly was detected. Will be set to 00:00 google time of the detected date.
+  "deviation": { # Encapsulates the deviation information. # Deviation information of the anomaly.
+    "actualSpend": { # Represents an amount of money with its currency type. # The actual spend for the anomaly.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "deviationAmount": { # Represents an amount of money with its currency type. # The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "deviationPercentage": 3.14, # The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.
+    "expectedSpend": { # Represents an amount of money with its currency type. # The expected spend for the anomaly.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+  },
+  "name": "A String", # Identifier. Resource name for the anomaly.
+  "resourceDisplayName": "A String", # The display name of the resource that the anomaly occurred in/belongs to.
+  "rootCauses": [ # A list of causes which contribute to the anomaly.
+    { # Encapsulates the information of the reason which caused the anomaly.
+      "causeType": "A String", # The cause type.
+      "deviation": { # Encapsulates the deviation information. # The deviation information for the cause.
+        "actualSpend": { # Represents an amount of money with its currency type. # The actual spend for the anomaly.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "deviationAmount": { # Represents an amount of money with its currency type. # The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "deviationPercentage": 3.14, # The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.
+        "expectedSpend": { # Represents an amount of money with its currency type. # The expected spend for the anomaly.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+      },
+      "displayName": "A String", # The display name of the cause.
+      "resource": "A String", # The resource name of the cause. project: projects/{project}. service: services/{service}. sku: services/{service}/skus/{sku}.
+      "subCauses": [ # The sub causes.
+        # Object with schema name: GoogleCloudBillingAnomaliesV1betaCause
+      ],
+    },
+  ],
+  "scope": "A String", # Indicate the scope of the anomaly.
+  "severity": "A String", # Severity of the anomaly. Unspecified if severity is not met/assigned.
+  "updateTime": "A String", # Output only. The most recent anomaly's last updated time.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists anomalies for a billing account or a project.
+
+Args:
+  parent: string, Required. The project to list Anomaly for the project. Format for project: projects/{project}. Format for billing account: billingAccounts/{billing_account}. (required)
+  filter: string, Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days' anomalies. Examples: - start_time = "20231201" AND end_time = "20240120" .
+  pageSize: integer, Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000.
+  pageToken: string, Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListAnomalies.
+  "anomalies": [ # The returned anomalies.
+    { # Encapsulates an anomaly.
+      "detectionTime": "A String", # Time that the anomaly was detected. Will be set to 00:00 google time of the detected date.
+      "deviation": { # Encapsulates the deviation information. # Deviation information of the anomaly.
+        "actualSpend": { # Represents an amount of money with its currency type. # The actual spend for the anomaly.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "deviationAmount": { # Represents an amount of money with its currency type. # The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "deviationPercentage": 3.14, # The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.
+        "expectedSpend": { # Represents an amount of money with its currency type. # The expected spend for the anomaly.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+      },
+      "name": "A String", # Identifier. Resource name for the anomaly.
+      "resourceDisplayName": "A String", # The display name of the resource that the anomaly occurred in/belongs to.
+      "rootCauses": [ # A list of causes which contribute to the anomaly.
+        { # Encapsulates the information of the reason which caused the anomaly.
+          "causeType": "A String", # The cause type.
+          "deviation": { # Encapsulates the deviation information. # The deviation information for the cause.
+            "actualSpend": { # Represents an amount of money with its currency type. # The actual spend for the anomaly.
+              "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+              "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+              "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+            },
+            "deviationAmount": { # Represents an amount of money with its currency type. # The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend.
+              "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+              "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+              "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+            },
+            "deviationPercentage": 3.14, # The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.
+            "expectedSpend": { # Represents an amount of money with its currency type. # The expected spend for the anomaly.
+              "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+              "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+              "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+            },
+          },
+          "displayName": "A String", # The display name of the cause.
+          "resource": "A String", # The resource name of the cause. project: projects/{project}. service: services/{service}. sku: services/{service}/skus/{sku}.
+          "subCauses": [ # The sub causes.
+            # Object with schema name: GoogleCloudBillingAnomaliesV1betaCause
+          ],
+        },
+      ],
+      "scope": "A String", # Indicate the scope of the anomaly.
+      "severity": "A String", # Severity of the anomaly. Unspecified if severity is not met/assigned.
+      "updateTime": "A String", # Output only. The most recent anomaly's last updated time.
+    },
+  ],
+  "nextPageToken": "A String", # Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
+}
+
+ +
+ list_next() + 
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/cloudbilling_v1beta.projects.html b/docs/dyn/cloudbilling_v1beta.projects.html new file mode 100644 index 00000000000..68541f3fd1a --- /dev/null +++ b/docs/dyn/cloudbilling_v1beta.projects.html @@ -0,0 +1,91 @@ + + + +

Cloud Billing API . projects

+

Instance Methods

+

+ anomalies() +

+

Returns the anomalies Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json index e4dee643234..3108947c1b5 100644 --- a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json @@ -751,7 +751,7 @@ } } }, -"revision": "20240214", +"revision": "20240301", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "AggregationInfo": { diff --git a/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json b/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json index a1e4ee00920..2f2f28574b0 100644 --- a/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +++ b/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json @@ -145,6 +145,80 @@ } }, "resources": { +"anomalies": { +"methods": { +"get": { +"description": "Gets an anomaly for a billing account or a project.", +"flatPath": "v1beta/billingAccounts/{billingAccountsId}/anomalies/{anomaliesId}", +"httpMethod": "GET", +"id": "cloudbilling.billingAccounts.anomalies.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format for project: projects/{project}/anomalies/{anomalies}. Format for billing account: billingAccounts/{billing_account}/anomalies/{anomalies}.", +"location": "path", +"pattern": "^billingAccounts/[^/]+/anomalies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudBillingAnomaliesV1betaAnomaly" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-billing", +"https://www.googleapis.com/auth/cloud-billing.readonly", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists anomalies for a billing account or a project.", +"flatPath": "v1beta/billingAccounts/{billingAccountsId}/anomalies", +"httpMethod": "GET", +"id": "cloudbilling.billingAccounts.anomalies.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days' anomalies. Examples: - start_time = \"20231201\" AND end_time = \"20240120\" .", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project to list Anomaly for the project. Format for project: projects/{project}. Format for billing account: billingAccounts/{billing_account}.", +"location": "path", +"pattern": "^billingAccounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/anomalies", +"response": { +"$ref": "GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-billing", +"https://www.googleapis.com/auth/cloud-billing.readonly", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "services": { "methods": { "get": { @@ -515,6 +589,84 @@ } } }, +"projects": { +"resources": { +"anomalies": { +"methods": { +"get": { +"description": "Gets an anomaly for a billing account or a project.", +"flatPath": "v1beta/projects/{projectsId}/anomalies/{anomaliesId}", +"httpMethod": "GET", +"id": "cloudbilling.projects.anomalies.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format for project: projects/{project}/anomalies/{anomalies}. Format for billing account: billingAccounts/{billing_account}/anomalies/{anomalies}.", +"location": "path", +"pattern": "^projects/[^/]+/anomalies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudBillingAnomaliesV1betaAnomaly" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-billing", +"https://www.googleapis.com/auth/cloud-billing.readonly", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists anomalies for a billing account or a project.", +"flatPath": "v1beta/projects/{projectsId}/anomalies", +"httpMethod": "GET", +"id": "cloudbilling.projects.anomalies.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days' anomalies. Examples: - start_time = \"20231201\" AND end_time = \"20240120\" .", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project to list Anomaly for the project. Format for project: projects/{project}. Format for billing account: billingAccounts/{billing_account}.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/anomalies", +"response": { +"$ref": "GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-billing", +"https://www.googleapis.com/auth/cloud-billing.readonly", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "skuGroups": { "methods": { "get": { @@ -758,7 +910,7 @@ } } }, -"revision": "20240214", +"revision": "20240301", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "CacheFillRegions": { @@ -1319,6 +1471,157 @@ }, "type": "object" }, +"GoogleCloudBillingAnomaliesV1betaAnomaly": { +"description": "Encapsulates an anomaly.", +"id": "GoogleCloudBillingAnomaliesV1betaAnomaly", +"properties": { +"detectionTime": { +"description": "Time that the anomaly was detected. Will be set to 00:00 google time of the detected date.", +"format": "google-datetime", +"type": "string" +}, +"deviation": { +"$ref": "GoogleCloudBillingAnomaliesV1betaAnomalyDeviation", +"description": "Deviation information of the anomaly." +}, +"name": { +"description": "Identifier. Resource name for the anomaly.", +"type": "string" +}, +"resourceDisplayName": { +"description": "The display name of the resource that the anomaly occurred in/belongs to.", +"type": "string" +}, +"rootCauses": { +"description": "A list of causes which contribute to the anomaly.", +"items": { +"$ref": "GoogleCloudBillingAnomaliesV1betaCause" +}, +"type": "array" +}, +"scope": { +"description": "Indicate the scope of the anomaly.", +"enum": [ +"SCOPE_UNSPECIFIED", +"SCOPE_BILLING_ACCOUNT", +"SCOPE_PROJECT" +], +"enumDescriptions": [ +"Default unspecified value.", +"Indicates the anomaly is for a billing account.", +"Indicates the anomaly is for a project." +], +"type": "string" +}, +"severity": { +"description": "Severity of the anomaly. Unspecified if severity is not met/assigned.", +"enum": [ +"ANOMALY_SEVERITY_UNSPECIFIED", +"ANOMALY_SEVERITY_LOW", +"ANOMALY_SEVERITY_MEDIUM", +"ANOMALY_SEVERITY_HIGH" +], +"enumDescriptions": [ +"Default unspecified value.", +"Indicates the anomaly's severity is low.", +"Indicates the anomaly's severity is medium.", +"Indicates the anomaly's severity is high." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. The most recent anomaly's last updated time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudBillingAnomaliesV1betaAnomalyDeviation": { +"description": "Encapsulates the deviation information.", +"id": "GoogleCloudBillingAnomaliesV1betaAnomalyDeviation", +"properties": { +"actualSpend": { +"$ref": "Money", +"description": "The actual spend for the anomaly." +}, +"deviationAmount": { +"$ref": "Money", +"description": "The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend." +}, +"deviationPercentage": { +"description": "The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.", +"format": "double", +"type": "number" +}, +"expectedSpend": { +"$ref": "Money", +"description": "The expected spend for the anomaly." +} +}, +"type": "object" +}, +"GoogleCloudBillingAnomaliesV1betaCause": { +"description": "Encapsulates the information of the reason which caused the anomaly.", +"id": "GoogleCloudBillingAnomaliesV1betaCause", +"properties": { +"causeType": { +"description": "The cause type.", +"enum": [ +"CAUSE_TYPE_UNSPECIFIED", +"CAUSE_TYPE_PROJECT", +"CAUSE_TYPE_SERVICE", +"CAUSE_TYPE_SKU" +], +"enumDescriptions": [ +"Default unspecified value.", +"Caused by a project.", +"Caused by a service.", +"Caused by a SKU." +], +"type": "string" +}, +"deviation": { +"$ref": "GoogleCloudBillingAnomaliesV1betaAnomalyDeviation", +"description": "The deviation information for the cause." +}, +"displayName": { +"description": "The display name of the cause.", +"type": "string" +}, +"resource": { +"description": "The resource name of the cause. project: projects/{project}. service: services/{service}. sku: services/{service}/skus/{sku}.", +"type": "string" +}, +"subCauses": { +"description": "The sub causes.", +"items": { +"$ref": "GoogleCloudBillingAnomaliesV1betaCause" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse": { +"description": "Response message for ListAnomalies.", +"id": "GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse", +"properties": { +"anomalies": { +"description": "The returned anomalies.", +"items": { +"$ref": "GoogleCloudBillingAnomaliesV1betaAnomaly" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudBillingBillingaccountpricesV1betaAggregationInfo": { "description": "Encapsulates the aggregation information such as aggregation level and interval for a billing account price.", "id": "GoogleCloudBillingBillingaccountpricesV1betaAggregationInfo",