Package com.ibm.cloud.platform_services.usage_reports.v4

Class UsageReports

  • public class UsageReports
extends com.ibm.cloud.sdk.core.service.BaseService
    Usage reports for IBM Cloud accounts. API Version: 4.0.6

    • Field Detail

      • DEFAULT_SERVICE_NAME

        public static final java.lang.String DEFAULT_SERVICE_NAME
        Default service name used when configuring the `UsageReports` client.
        See Also:
        Constant Field Values

      • DEFAULT_SERVICE_URL

        public static final java.lang.String DEFAULT_SERVICE_URL
        Default service endpoint URL.
        See Also:
        Constant Field Values

    • Constructor Detail

      • UsageReports

        public UsageReports​(java.lang.String serviceName,
                    com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `UsageReports` client. The specified service name and authenticator are used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        authenticator - the Authenticator instance to be configured for this client

    • Method Detail

      • newInstance

        public static UsageReports newInstance()
        Class method which constructs an instance of the `UsageReports` client. The default service name is used to configure the client instance.
        Returns:
        an instance of the `UsageReports` client using external configuration

      • newInstance

        public static UsageReports newInstance​(java.lang.String serviceName)
        Class method which constructs an instance of the `UsageReports` client. The specified service name is used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        Returns:
        an instance of the `UsageReports` client using external configuration

      • getAccountSummary

        public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSummary> getAccountSummary​(GetAccountSummaryOptions getAccountSummaryOptions)
        Get account summary. Returns the summary for the account for a given month. Account billing managers are authorized to access this report.
        Parameters:
        getAccountSummaryOptions - the GetAccountSummaryOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type AccountSummary

      • getAccountUsage

        public com.ibm.cloud.sdk.core.http.ServiceCall<AccountUsage> getAccountUsage​(GetAccountUsageOptions getAccountUsageOptions)
        Get account usage. Usage for all the resources and plans in an account for a given month. Account billing managers are authorized to access this report.
        Parameters:
        getAccountUsageOptions - the GetAccountUsageOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type AccountUsage

      • getResourceGroupUsage

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceGroupUsage> getResourceGroupUsage​(GetResourceGroupUsageOptions getResourceGroupUsageOptions)
        Get resource group usage. Usage for all the resources and plans in a resource group in a given month. Account billing managers or resource group billing managers are authorized to access this report.
        Parameters:
        getResourceGroupUsageOptions - the GetResourceGroupUsageOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceGroupUsage

      • getResourceUsageAccount

        public com.ibm.cloud.sdk.core.http.ServiceCall<InstancesUsage> getResourceUsageAccount​(GetResourceUsageAccountOptions getResourceUsageAccountOptions)
        Get resource instance usage in an account. Query for resource instance usage in an account. Filter the results with query parameters. Account billing administrator is authorized to access this report.
        Parameters:
        getResourceUsageAccountOptions - the GetResourceUsageAccountOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InstancesUsage

      • getResourceUsageResourceGroup

        public com.ibm.cloud.sdk.core.http.ServiceCall<InstancesUsage> getResourceUsageResourceGroup​(GetResourceUsageResourceGroupOptions getResourceUsageResourceGroupOptions)
        Get resource instance usage in a resource group. Query for resource instance usage in a resource group. Filter the results with query parameters. Account billing administrator and resource group billing administrators are authorized to access this report.
        Parameters:
        getResourceUsageResourceGroupOptions - the GetResourceUsageResourceGroupOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InstancesUsage

      • getResourceUsageOrg

        public com.ibm.cloud.sdk.core.http.ServiceCall<InstancesUsage> getResourceUsageOrg​(GetResourceUsageOrgOptions getResourceUsageOrgOptions)
        Get resource instance usage in an organization. Query for resource instance usage in an organization. Filter the results with query parameters. Account billing administrator and organization billing administrators are authorized to access this report.
        Parameters:
        getResourceUsageOrgOptions - the GetResourceUsageOrgOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InstancesUsage

      • getOrgUsage

        public com.ibm.cloud.sdk.core.http.ServiceCall<OrgUsage> getOrgUsage​(GetOrgUsageOptions getOrgUsageOptions)
        Get organization usage. Usage for all the resources and plans in an organization in a given month. Account billing managers or organization billing managers are authorized to access this report.
        Parameters:
        getOrgUsageOptions - the GetOrgUsageOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type OrgUsage

      • createReportsSnapshotConfig

        public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotConfig> createReportsSnapshotConfig​(CreateReportsSnapshotConfigOptions createReportsSnapshotConfigOptions)
        Setup the snapshot configuration. Snapshots of the billing reports would be taken on a periodic interval and stored based on the configuration setup by the customer for the given Account Id.
        Parameters:
        createReportsSnapshotConfigOptions - the CreateReportsSnapshotConfigOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type SnapshotConfig

      • getReportsSnapshotConfig

        public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotConfig> getReportsSnapshotConfig​(GetReportsSnapshotConfigOptions getReportsSnapshotConfigOptions)
        Fetch the snapshot configuration. Returns the configuration of snapshot of the billing reports setup by the customer for the given Account Id.
        Parameters:
        getReportsSnapshotConfigOptions - the GetReportsSnapshotConfigOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type SnapshotConfig

      • updateReportsSnapshotConfig

        public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotConfig> updateReportsSnapshotConfig​(UpdateReportsSnapshotConfigOptions updateReportsSnapshotConfigOptions)
        Update the snapshot configuration. Updates the configuration of snapshot of the billing reports setup by the customer for the given Account Id.
        Parameters:
        updateReportsSnapshotConfigOptions - the UpdateReportsSnapshotConfigOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type SnapshotConfig

      • deleteReportsSnapshotConfig

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteReportsSnapshotConfig​(DeleteReportsSnapshotConfigOptions deleteReportsSnapshotConfigOptions)
        Delete the snapshot configuration. Delete the configuration of snapshot of the billing reports setup by the customer for the given Account Id.
        Parameters:
        deleteReportsSnapshotConfigOptions - the DeleteReportsSnapshotConfigOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getReportsSnapshot

        public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotList> getReportsSnapshot​(GetReportsSnapshotOptions getReportsSnapshotOptions)
        Fetch the current or past snapshots. Returns the billing reports snapshots captured for the given Account Id in the specific time period.
        Parameters:
        getReportsSnapshotOptions - the GetReportsSnapshotOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type SnapshotList