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.