Package com.datadog.api.client.v2.api
Class UsageMeteringApi
java.lang.Object
com.datadog.api.client.v2.api.UsageMeteringApi
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class UsageMeteringApi
extends Object
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classManage optional parameters to createQuotas.static classManage optional parameters to getBillingDimensionMapping.static classManage optional parameters to getCostByOrg.static classManage optional parameters to getEstimatedCostByOrg.static classManage optional parameters to getHistoricalCostByOrg.static classManage optional parameters to getHourlyUsage.static classManage optional parameters to getMonthlyCostAttribution.static classManage optional parameters to getProjectedCost.static classManage optional parameters to getUsageApplicationSecurityMonitoring.static classManage optional parameters to getUsageLambdaTracedInvocations.static classManage optional parameters to getUsageObservabilityPipelines.static classManage optional parameters to listQuotas. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateQuotas(String quotaNamespace, UsageQuotasCreateRequest body) Create or update usage quotas.createQuotas(String quotaNamespace, UsageQuotasCreateRequest body, UsageMeteringApi.CreateQuotasOptionalParameters parameters) Create or update usage quotas.createQuotasAsync(String quotaNamespace, UsageQuotasCreateRequest body) Create or update usage quotas.createQuotasAsync(String quotaNamespace, UsageQuotasCreateRequest body, UsageMeteringApi.CreateQuotasOptionalParameters parameters) Create or update usage quotas.createQuotasWithHttpInfo(String quotaNamespace, UsageQuotasCreateRequest body, UsageMeteringApi.CreateQuotasOptionalParameters parameters) Creates or updates one or more usage quotas by scope.createQuotasWithHttpInfoAsync(String quotaNamespace, UsageQuotasCreateRequest body, UsageMeteringApi.CreateQuotasOptionalParameters parameters) Create or update usage quotas.voiddeleteQuota(String quotaNamespace, String id) Delete a usage quota.deleteQuotaAsync(String quotaNamespace, String id) Delete a usage quota.deleteQuotaWithHttpInfo(String quotaNamespace, String id) Deletes a usage quota by its opaque identifier.deleteQuotaWithHttpInfoAsync(String quotaNamespace, String id) Delete a usage quota.Get active billing dimensions for cost attribution.Get active billing dimensions for cost attribution.Get active billing dimensions for cost attribution.Get active billing dimensions for cost attribution.Get the API client.Get billing dimension mapping for usage endpoints.getBillingDimensionMapping(UsageMeteringApi.GetBillingDimensionMappingOptionalParameters parameters) Get billing dimension mapping for usage endpoints.Get billing dimension mapping for usage endpoints.getBillingDimensionMappingAsync(UsageMeteringApi.GetBillingDimensionMappingOptionalParameters parameters) Get billing dimension mapping for usage endpoints.getBillingDimensionMappingWithHttpInfo(UsageMeteringApi.GetBillingDimensionMappingOptionalParameters parameters) Get a mapping of billing dimensions to the corresponding keys for the supported usage metering public API endpoints.getBillingDimensionMappingWithHttpInfoAsync(UsageMeteringApi.GetBillingDimensionMappingOptionalParameters parameters) Get billing dimension mapping for usage endpoints.getCostByOrg(OffsetDateTime startMonth) Deprecated.getCostByOrg(OffsetDateTime startMonth, UsageMeteringApi.GetCostByOrgOptionalParameters parameters) Deprecated.getCostByOrgAsync(OffsetDateTime startMonth) Deprecated.getCostByOrgAsync(OffsetDateTime startMonth, UsageMeteringApi.GetCostByOrgOptionalParameters parameters) Deprecated.getCostByOrgWithHttpInfo(OffsetDateTime startMonth, UsageMeteringApi.GetCostByOrgOptionalParameters parameters) Deprecated.getCostByOrgWithHttpInfoAsync(OffsetDateTime startMonth, UsageMeteringApi.GetCostByOrgOptionalParameters parameters) Deprecated.Get estimated cost across your account.Get estimated cost across your account.Get estimated cost across your account.Get estimated cost across your account.getEstimatedCostByOrgWithHttpInfo(UsageMeteringApi.GetEstimatedCostByOrgOptionalParameters parameters) Get estimated cost across multi-org and single root-org accounts.getEstimatedCostByOrgWithHttpInfoAsync(UsageMeteringApi.GetEstimatedCostByOrgOptionalParameters parameters) Get estimated cost across your account.getHistoricalCostByOrg(OffsetDateTime startMonth) Get historical cost across your account.getHistoricalCostByOrg(OffsetDateTime startMonth, UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters parameters) Get historical cost across your account.getHistoricalCostByOrgAsync(OffsetDateTime startMonth) Get historical cost across your account.getHistoricalCostByOrgAsync(OffsetDateTime startMonth, UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters parameters) Get historical cost across your account.getHistoricalCostByOrgWithHttpInfo(OffsetDateTime startMonth, UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters parameters) Get historical cost across multi-org and single root-org accounts.getHistoricalCostByOrgWithHttpInfoAsync(OffsetDateTime startMonth, UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters parameters) Get historical cost across your account.getHourlyUsage(OffsetDateTime filterTimestampStart, String filterProductFamilies) Get hourly usage by product family.getHourlyUsage(OffsetDateTime filterTimestampStart, String filterProductFamilies, UsageMeteringApi.GetHourlyUsageOptionalParameters parameters) Get hourly usage by product family.getHourlyUsageAsync(OffsetDateTime filterTimestampStart, String filterProductFamilies) Get hourly usage by product family.getHourlyUsageAsync(OffsetDateTime filterTimestampStart, String filterProductFamilies, UsageMeteringApi.GetHourlyUsageOptionalParameters parameters) Get hourly usage by product family.getHourlyUsageWithHttpInfo(OffsetDateTime filterTimestampStart, String filterProductFamilies, UsageMeteringApi.GetHourlyUsageOptionalParameters parameters) Get hourly usage by product family.getHourlyUsageWithHttpInfoAsync(OffsetDateTime filterTimestampStart, String filterProductFamilies, UsageMeteringApi.GetHourlyUsageOptionalParameters parameters) Get hourly usage by product family.getMonthlyCostAttribution(OffsetDateTime startMonth, String fields) Get Monthly Cost Attribution.getMonthlyCostAttribution(OffsetDateTime startMonth, String fields, UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters parameters) Get Monthly Cost Attribution.getMonthlyCostAttributionAsync(OffsetDateTime startMonth, String fields) Get Monthly Cost Attribution.getMonthlyCostAttributionAsync(OffsetDateTime startMonth, String fields, UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters parameters) Get Monthly Cost Attribution.getMonthlyCostAttributionWithHttpInfo(OffsetDateTime startMonth, String fields, UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters parameters) Get monthly cost attribution by tag across multi-org and single root-org accounts.getMonthlyCostAttributionWithHttpInfoAsync(OffsetDateTime startMonth, String fields, UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters parameters) Get Monthly Cost Attribution.Get projected cost across your account.Get projected cost across your account.Get projected cost across your account.Get projected cost across your account.Get projected cost across multi-org and single root-org accounts.Get projected cost across your account.Deprecated.getUsageApplicationSecurityMonitoring(OffsetDateTime startHr, UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters parameters) Deprecated.Deprecated.getUsageApplicationSecurityMonitoringAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters parameters) Deprecated.getUsageApplicationSecurityMonitoringWithHttpInfo(OffsetDateTime startHr, UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters parameters) Deprecated.getUsageApplicationSecurityMonitoringWithHttpInfoAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters parameters) Deprecated.Get usage attribution types.Get usage attribution types.Get usage attribution types.Get usage attribution types.Deprecated.getUsageLambdaTracedInvocations(OffsetDateTime startHr, UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters parameters) Deprecated.Deprecated.getUsageLambdaTracedInvocationsAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters parameters) Deprecated.getUsageLambdaTracedInvocationsWithHttpInfo(OffsetDateTime startHr, UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters parameters) Deprecated.getUsageLambdaTracedInvocationsWithHttpInfoAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters parameters) Deprecated.Deprecated.getUsageObservabilityPipelines(OffsetDateTime startHr, UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters parameters) Deprecated.Deprecated.getUsageObservabilityPipelinesAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters parameters) Deprecated.getUsageObservabilityPipelinesWithHttpInfo(OffsetDateTime startHr, UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters parameters) Deprecated.getUsageObservabilityPipelinesWithHttpInfoAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters parameters) Deprecated.Get available fields for usage summary.Get available fields for usage summary.List the field names returned byGET /api/v1/usage/summaryat each of its three response levels.Get available fields for usage summary.listQuotas(String quotaNamespace) List usage quotas.listQuotas(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters) List usage quotas.listQuotasAsync(String quotaNamespace) List usage quotas.listQuotasAsync(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters) List usage quotas.listQuotasWithHttpInfo(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters) Lists usage quotas for the caller's organization in a quota namespace.listQuotasWithHttpInfoAsync(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters) List usage quotas.listQuotasWithPagination(String quotaNamespace) List usage quotas.listQuotasWithPagination(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters) List usage quotas.voidsetApiClient(ApiClient apiClient) Set the API client.updateQuota(String quotaNamespace, String id, UsageQuotaUpdateRequest body) Update a usage quota.updateQuotaAsync(String quotaNamespace, String id, UsageQuotaUpdateRequest body) Update a usage quota.updateQuotaWithHttpInfo(String quotaNamespace, String id, UsageQuotaUpdateRequest body) Updates the supplied fields on a usage quota and leaves omitted fields unchanged.updateQuotaWithHttpInfoAsync(String quotaNamespace, String id, UsageQuotaUpdateRequest body) Update a usage quota.
-
Constructor Details
-
UsageMeteringApi
public UsageMeteringApi() -
UsageMeteringApi
-
-
Method Details
-
getApiClient
Get the API client.- Returns:
- API client
-
setApiClient
Set the API client.- Parameters:
apiClient- an instance of API client
-
createQuotas
public UsageQuotasBulkResponse createQuotas(String quotaNamespace, UsageQuotasCreateRequest body) throws ApiException Create or update usage quotas.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)body- The usage quotas to create or update. (required)- Returns:
- UsageQuotasBulkResponse
- Throws:
ApiException- if fails to make API call
-
createQuotasAsync
public CompletableFuture<UsageQuotasBulkResponse> createQuotasAsync(String quotaNamespace, UsageQuotasCreateRequest body) Create or update usage quotas.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)body- The usage quotas to create or update. (required)- Returns:
- CompletableFuture<UsageQuotasBulkResponse>
-
createQuotas
public UsageQuotasBulkResponse createQuotas(String quotaNamespace, UsageQuotasCreateRequest body, UsageMeteringApi.CreateQuotasOptionalParameters parameters) throws ApiException Create or update usage quotas.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)body- The usage quotas to create or update. (required)parameters- Optional parameters for the request.- Returns:
- UsageQuotasBulkResponse
- Throws:
ApiException- if fails to make API call
-
createQuotasAsync
public CompletableFuture<UsageQuotasBulkResponse> createQuotasAsync(String quotaNamespace, UsageQuotasCreateRequest body, UsageMeteringApi.CreateQuotasOptionalParameters parameters) Create or update usage quotas.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)body- The usage quotas to create or update. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<UsageQuotasBulkResponse>
-
createQuotasWithHttpInfo
public ApiResponse<UsageQuotasBulkResponse> createQuotasWithHttpInfo(String quotaNamespace, UsageQuotasCreateRequest body, UsageMeteringApi.CreateQuotasOptionalParameters parameters) throws ApiException Creates or updates one or more usage quotas by scope. If a quota already exists for a supplied scope, it is updated; otherwise, a new quota is created. Requires thebilling_editpermission.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)body- The usage quotas to create or update. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<UsageQuotasBulkResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK. The response includes each item's result; see each item's `error` attribute for any that failed to write. - 400 Bad Request - 403 Forbidden - 429 Too many requests - 500 Internal Server Error. Every item in the batch failed to write. -
-
createQuotasWithHttpInfoAsync
public CompletableFuture<ApiResponse<UsageQuotasBulkResponse>> createQuotasWithHttpInfoAsync(String quotaNamespace, UsageQuotasCreateRequest body, UsageMeteringApi.CreateQuotasOptionalParameters parameters) Create or update usage quotas.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)body- The usage quotas to create or update. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<UsageQuotasBulkResponse>>
-
deleteQuota
Delete a usage quota.See
deleteQuotaWithHttpInfo(java.lang.String, java.lang.String).- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)id- The opaque quota identifier returned by a previous list or create request. Clients must pass this value verbatim. (required)- Throws:
ApiException- if fails to make API call
-
deleteQuotaAsync
Delete a usage quota.See
deleteQuotaWithHttpInfoAsync(java.lang.String, java.lang.String).- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)id- The opaque quota identifier returned by a previous list or create request. Clients must pass this value verbatim. (required)- Returns:
- CompletableFuture
-
deleteQuotaWithHttpInfo
public ApiResponse<Void> deleteQuotaWithHttpInfo(String quotaNamespace, String id) throws ApiException Deletes a usage quota by its opaque identifier. The quota must belong to the caller's organization or one of its descendants, and its opaque identifier must belong to the requested quota namespace. Requires thebilling_editpermission.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)id- The opaque quota identifier returned by a previous list or create request. Clients must pass this value verbatim. (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 204 No Content - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
deleteQuotaWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> deleteQuotaWithHttpInfoAsync(String quotaNamespace, String id) Delete a usage quota.See
deleteQuotaWithHttpInfo(java.lang.String, java.lang.String).- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)id- The opaque quota identifier returned by a previous list or create request. Clients must pass this value verbatim. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
getActiveBillingDimensions
Get active billing dimensions for cost attribution.- Returns:
- ActiveBillingDimensionsResponse
- Throws:
ApiException- if fails to make API call
-
getActiveBillingDimensionsAsync
Get active billing dimensions for cost attribution.- Returns:
- CompletableFuture<ActiveBillingDimensionsResponse>
-
getActiveBillingDimensionsWithHttpInfo
public ApiResponse<ActiveBillingDimensionsResponse> getActiveBillingDimensionsWithHttpInfo() throws ApiExceptionGet active billing dimensions for cost attribution. Cost data for a given month becomes available no later than the 19th of the following month.- Returns:
- ApiResponse<ActiveBillingDimensionsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 429 Too many requests -
-
getActiveBillingDimensionsWithHttpInfoAsync
public CompletableFuture<ApiResponse<ActiveBillingDimensionsResponse>> getActiveBillingDimensionsWithHttpInfoAsync()Get active billing dimensions for cost attribution.- Returns:
- CompletableFuture<ApiResponse<ActiveBillingDimensionsResponse>>
-
getBillingDimensionMapping
Get billing dimension mapping for usage endpoints.- Returns:
- BillingDimensionsMappingResponse
- Throws:
ApiException- if fails to make API call
-
getBillingDimensionMappingAsync
Get billing dimension mapping for usage endpoints.- Returns:
- CompletableFuture<BillingDimensionsMappingResponse>
-
getBillingDimensionMapping
public BillingDimensionsMappingResponse getBillingDimensionMapping(UsageMeteringApi.GetBillingDimensionMappingOptionalParameters parameters) throws ApiException Get billing dimension mapping for usage endpoints.- Parameters:
parameters- Optional parameters for the request.- Returns:
- BillingDimensionsMappingResponse
- Throws:
ApiException- if fails to make API call
-
getBillingDimensionMappingAsync
public CompletableFuture<BillingDimensionsMappingResponse> getBillingDimensionMappingAsync(UsageMeteringApi.GetBillingDimensionMappingOptionalParameters parameters) Get billing dimension mapping for usage endpoints.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<BillingDimensionsMappingResponse>
-
getBillingDimensionMappingWithHttpInfo
public ApiResponse<BillingDimensionsMappingResponse> getBillingDimensionMappingWithHttpInfo(UsageMeteringApi.GetBillingDimensionMappingOptionalParameters parameters) throws ApiException Get a mapping of billing dimensions to the corresponding keys for the supported usage metering public API endpoints. Mapping data is updated on a monthly cadence.This endpoint is only accessible to parent-level organizations.
- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<BillingDimensionsMappingResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 429 Too many requests -
-
getBillingDimensionMappingWithHttpInfoAsync
public CompletableFuture<ApiResponse<BillingDimensionsMappingResponse>> getBillingDimensionMappingWithHttpInfoAsync(UsageMeteringApi.GetBillingDimensionMappingOptionalParameters parameters) Get billing dimension mapping for usage endpoints.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<BillingDimensionsMappingResponse>>
-
getCostByOrg
Deprecated.Get cost across multi-org account.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning this month. (required)- Returns:
- CostByOrgResponse
- Throws:
ApiException- if fails to make API call
-
getCostByOrgAsync
@Deprecated public CompletableFuture<CostByOrgResponse> getCostByOrgAsync(OffsetDateTime startMonth) Deprecated.Get cost across multi-org account.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning this month. (required)- Returns:
- CompletableFuture<CostByOrgResponse>
-
getCostByOrg
@Deprecated public CostByOrgResponse getCostByOrg(OffsetDateTime startMonth, UsageMeteringApi.GetCostByOrgOptionalParameters parameters) throws ApiException Deprecated.Get cost across multi-org account.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning this month. (required)parameters- Optional parameters for the request.- Returns:
- CostByOrgResponse
- Throws:
ApiException- if fails to make API call
-
getCostByOrgAsync
@Deprecated public CompletableFuture<CostByOrgResponse> getCostByOrgAsync(OffsetDateTime startMonth, UsageMeteringApi.GetCostByOrgOptionalParameters parameters) Deprecated.Get cost across multi-org account.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning this month. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<CostByOrgResponse>
-
getCostByOrgWithHttpInfo
@Deprecated public ApiResponse<CostByOrgResponse> getCostByOrgWithHttpInfo(OffsetDateTime startMonth, UsageMeteringApi.GetCostByOrgOptionalParameters parameters) throws ApiException Deprecated.Get cost across multi-org account. Cost by org data for a given month becomes available no later than the 16th of the following month. Note: This endpoint has been deprecated. Please use the new endpoint/historical_costinstead.This endpoint is only accessible for parent-level organizations.
- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning this month. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<CostByOrgResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 429 Too many requests -
-
getCostByOrgWithHttpInfoAsync
@Deprecated public CompletableFuture<ApiResponse<CostByOrgResponse>> getCostByOrgWithHttpInfoAsync(OffsetDateTime startMonth, UsageMeteringApi.GetCostByOrgOptionalParameters parameters) Deprecated.Get cost across multi-org account.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning this month. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<CostByOrgResponse>>
-
getEstimatedCostByOrg
Get estimated cost across your account.- Returns:
- CostByOrgResponse
- Throws:
ApiException- if fails to make API call
-
getEstimatedCostByOrgAsync
Get estimated cost across your account.- Returns:
- CompletableFuture<CostByOrgResponse>
-
getEstimatedCostByOrg
public CostByOrgResponse getEstimatedCostByOrg(UsageMeteringApi.GetEstimatedCostByOrgOptionalParameters parameters) throws ApiException Get estimated cost across your account.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CostByOrgResponse
- Throws:
ApiException- if fails to make API call
-
getEstimatedCostByOrgAsync
public CompletableFuture<CostByOrgResponse> getEstimatedCostByOrgAsync(UsageMeteringApi.GetEstimatedCostByOrgOptionalParameters parameters) Get estimated cost across your account.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<CostByOrgResponse>
-
getEstimatedCostByOrgWithHttpInfo
public ApiResponse<CostByOrgResponse> getEstimatedCostByOrgWithHttpInfo(UsageMeteringApi.GetEstimatedCostByOrgOptionalParameters parameters) throws ApiException Get estimated cost across multi-org and single root-org accounts. Estimated cost data is only available for the current month and previous month and is delayed by up to 72 hours from when it was incurred. To access historical costs prior to this, use the/historical_costendpoint.This endpoint is only accessible for parent-level organizations.
- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<CostByOrgResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 429 Too many requests -
-
getEstimatedCostByOrgWithHttpInfoAsync
public CompletableFuture<ApiResponse<CostByOrgResponse>> getEstimatedCostByOrgWithHttpInfoAsync(UsageMeteringApi.GetEstimatedCostByOrgOptionalParameters parameters) Get estimated cost across your account.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<CostByOrgResponse>>
-
getHistoricalCostByOrg
Get historical cost across your account.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning this month. (required)- Returns:
- CostByOrgResponse
- Throws:
ApiException- if fails to make API call
-
getHistoricalCostByOrgAsync
Get historical cost across your account.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning this month. (required)- Returns:
- CompletableFuture<CostByOrgResponse>
-
getHistoricalCostByOrg
public CostByOrgResponse getHistoricalCostByOrg(OffsetDateTime startMonth, UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters parameters) throws ApiException Get historical cost across your account.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning this month. (required)parameters- Optional parameters for the request.- Returns:
- CostByOrgResponse
- Throws:
ApiException- if fails to make API call
-
getHistoricalCostByOrgAsync
public CompletableFuture<CostByOrgResponse> getHistoricalCostByOrgAsync(OffsetDateTime startMonth, UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters parameters) Get historical cost across your account.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning this month. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<CostByOrgResponse>
-
getHistoricalCostByOrgWithHttpInfo
public ApiResponse<CostByOrgResponse> getHistoricalCostByOrgWithHttpInfo(OffsetDateTime startMonth, UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters parameters) throws ApiException Get historical cost across multi-org and single root-org accounts. Cost data for a given month becomes available no later than the 16th of the following month.This endpoint is only accessible for parent-level organizations.
- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning this month. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<CostByOrgResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 429 Too many requests -
-
getHistoricalCostByOrgWithHttpInfoAsync
public CompletableFuture<ApiResponse<CostByOrgResponse>> getHistoricalCostByOrgWithHttpInfoAsync(OffsetDateTime startMonth, UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters parameters) Get historical cost across your account.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning this month. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<CostByOrgResponse>>
-
getHourlyUsage
public HourlyUsageResponse getHourlyUsage(OffsetDateTime filterTimestampStart, String filterProductFamilies) throws ApiException Get hourly usage by product family.- Parameters:
filterTimestampStart- Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. (required)filterProductFamilies- Comma separated list of product families to retrieve. Available families areall,ai,analyzed_logs,application_performance_monitoring,application_security,audit_trail,bits_ai,serverless,ci_app,cloud_cost_management,cloud_siem,csm_container_enterprise,csm_host_enterprise,csm_host_pro,cspm,custom_events,cws,data_observability,dbm,digital_experience_management,error_tracking,fargate,infra_hosts,incident_management,indexed_logs,indexed_spans,infrastructure_monitoring,ingested_spans,iot,lambda_traced_invocations,llm_observability,log_management,logs,network_flows,network_hosts,network_monitoring,observability_pipelines,online_archive,platform_capabilities,product_analytics,profiling,rum,rum_browser_sessions,rum_mobile_sessions,sds,security,snmp,software_delivery,synthetics_api,synthetics_browser,synthetics_mobile,synthetics_parallel_testing,timeseries,vuln_managementandworkflow_executions. The following product family has been deprecated:audit_logs. (required)- Returns:
- HourlyUsageResponse
- Throws:
ApiException- if fails to make API call
-
getHourlyUsageAsync
public CompletableFuture<HourlyUsageResponse> getHourlyUsageAsync(OffsetDateTime filterTimestampStart, String filterProductFamilies) Get hourly usage by product family.- Parameters:
filterTimestampStart- Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. (required)filterProductFamilies- Comma separated list of product families to retrieve. Available families areall,ai,analyzed_logs,application_performance_monitoring,application_security,audit_trail,bits_ai,serverless,ci_app,cloud_cost_management,cloud_siem,csm_container_enterprise,csm_host_enterprise,csm_host_pro,cspm,custom_events,cws,data_observability,dbm,digital_experience_management,error_tracking,fargate,infra_hosts,incident_management,indexed_logs,indexed_spans,infrastructure_monitoring,ingested_spans,iot,lambda_traced_invocations,llm_observability,log_management,logs,network_flows,network_hosts,network_monitoring,observability_pipelines,online_archive,platform_capabilities,product_analytics,profiling,rum,rum_browser_sessions,rum_mobile_sessions,sds,security,snmp,software_delivery,synthetics_api,synthetics_browser,synthetics_mobile,synthetics_parallel_testing,timeseries,vuln_managementandworkflow_executions. The following product family has been deprecated:audit_logs. (required)- Returns:
- CompletableFuture<HourlyUsageResponse>
-
getHourlyUsage
public HourlyUsageResponse getHourlyUsage(OffsetDateTime filterTimestampStart, String filterProductFamilies, UsageMeteringApi.GetHourlyUsageOptionalParameters parameters) throws ApiException Get hourly usage by product family.- Parameters:
filterTimestampStart- Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. (required)filterProductFamilies- Comma separated list of product families to retrieve. Available families areall,ai,analyzed_logs,application_performance_monitoring,application_security,audit_trail,bits_ai,serverless,ci_app,cloud_cost_management,cloud_siem,csm_container_enterprise,csm_host_enterprise,csm_host_pro,cspm,custom_events,cws,data_observability,dbm,digital_experience_management,error_tracking,fargate,infra_hosts,incident_management,indexed_logs,indexed_spans,infrastructure_monitoring,ingested_spans,iot,lambda_traced_invocations,llm_observability,log_management,logs,network_flows,network_hosts,network_monitoring,observability_pipelines,online_archive,platform_capabilities,product_analytics,profiling,rum,rum_browser_sessions,rum_mobile_sessions,sds,security,snmp,software_delivery,synthetics_api,synthetics_browser,synthetics_mobile,synthetics_parallel_testing,timeseries,vuln_managementandworkflow_executions. The following product family has been deprecated:audit_logs. (required)parameters- Optional parameters for the request.- Returns:
- HourlyUsageResponse
- Throws:
ApiException- if fails to make API call
-
getHourlyUsageAsync
public CompletableFuture<HourlyUsageResponse> getHourlyUsageAsync(OffsetDateTime filterTimestampStart, String filterProductFamilies, UsageMeteringApi.GetHourlyUsageOptionalParameters parameters) Get hourly usage by product family.- Parameters:
filterTimestampStart- Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. (required)filterProductFamilies- Comma separated list of product families to retrieve. Available families areall,ai,analyzed_logs,application_performance_monitoring,application_security,audit_trail,bits_ai,serverless,ci_app,cloud_cost_management,cloud_siem,csm_container_enterprise,csm_host_enterprise,csm_host_pro,cspm,custom_events,cws,data_observability,dbm,digital_experience_management,error_tracking,fargate,infra_hosts,incident_management,indexed_logs,indexed_spans,infrastructure_monitoring,ingested_spans,iot,lambda_traced_invocations,llm_observability,log_management,logs,network_flows,network_hosts,network_monitoring,observability_pipelines,online_archive,platform_capabilities,product_analytics,profiling,rum,rum_browser_sessions,rum_mobile_sessions,sds,security,snmp,software_delivery,synthetics_api,synthetics_browser,synthetics_mobile,synthetics_parallel_testing,timeseries,vuln_managementandworkflow_executions. The following product family has been deprecated:audit_logs. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<HourlyUsageResponse>
-
getHourlyUsageWithHttpInfo
public ApiResponse<HourlyUsageResponse> getHourlyUsageWithHttpInfo(OffsetDateTime filterTimestampStart, String filterProductFamilies, UsageMeteringApi.GetHourlyUsageOptionalParameters parameters) throws ApiException Get hourly usage by product family.- Parameters:
filterTimestampStart- Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. (required)filterProductFamilies- Comma separated list of product families to retrieve. Available families areall,ai,analyzed_logs,application_performance_monitoring,application_security,audit_trail,bits_ai,serverless,ci_app,cloud_cost_management,cloud_siem,csm_container_enterprise,csm_host_enterprise,csm_host_pro,cspm,custom_events,cws,data_observability,dbm,digital_experience_management,error_tracking,fargate,infra_hosts,incident_management,indexed_logs,indexed_spans,infrastructure_monitoring,ingested_spans,iot,lambda_traced_invocations,llm_observability,log_management,logs,network_flows,network_hosts,network_monitoring,observability_pipelines,online_archive,platform_capabilities,product_analytics,profiling,rum,rum_browser_sessions,rum_mobile_sessions,sds,security,snmp,software_delivery,synthetics_api,synthetics_browser,synthetics_mobile,synthetics_parallel_testing,timeseries,vuln_managementandworkflow_executions. The following product family has been deprecated:audit_logs. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<HourlyUsageResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 429 Too many requests -
-
getHourlyUsageWithHttpInfoAsync
public CompletableFuture<ApiResponse<HourlyUsageResponse>> getHourlyUsageWithHttpInfoAsync(OffsetDateTime filterTimestampStart, String filterProductFamilies, UsageMeteringApi.GetHourlyUsageOptionalParameters parameters) Get hourly usage by product family.- Parameters:
filterTimestampStart- Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. (required)filterProductFamilies- Comma separated list of product families to retrieve. Available families areall,ai,analyzed_logs,application_performance_monitoring,application_security,audit_trail,bits_ai,serverless,ci_app,cloud_cost_management,cloud_siem,csm_container_enterprise,csm_host_enterprise,csm_host_pro,cspm,custom_events,cws,data_observability,dbm,digital_experience_management,error_tracking,fargate,infra_hosts,incident_management,indexed_logs,indexed_spans,infrastructure_monitoring,ingested_spans,iot,lambda_traced_invocations,llm_observability,log_management,logs,network_flows,network_hosts,network_monitoring,observability_pipelines,online_archive,platform_capabilities,product_analytics,profiling,rum,rum_browser_sessions,rum_mobile_sessions,sds,security,snmp,software_delivery,synthetics_api,synthetics_browser,synthetics_mobile,synthetics_parallel_testing,timeseries,vuln_managementandworkflow_executions. The following product family has been deprecated:audit_logs. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<HourlyUsageResponse>>
-
getMonthlyCostAttribution
public MonthlyCostAttributionResponse getMonthlyCostAttribution(OffsetDateTime startMonth, String fields) throws ApiException Get Monthly Cost Attribution.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning in this month. (required)fields- Comma-separated list specifying cost types (e.g.,<billing_dimension>_on_demand_cost,<billing_dimension>_committed_cost,<billing_dimension>_total_cost) and the proportions (<billing_dimension>_percentage_in_org,<billing_dimension>_percentage_in_account). Use*to retrieve all fields. Example:infra_host_on_demand_cost,infra_host_percentage_in_accountTo obtain the complete list of active billing dimensions that can be used to replace<billing_dimension>in the field names, make a request to the Get active billing dimensions API. (required)- Returns:
- MonthlyCostAttributionResponse
- Throws:
ApiException- if fails to make API call
-
getMonthlyCostAttributionAsync
public CompletableFuture<MonthlyCostAttributionResponse> getMonthlyCostAttributionAsync(OffsetDateTime startMonth, String fields) Get Monthly Cost Attribution.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning in this month. (required)fields- Comma-separated list specifying cost types (e.g.,<billing_dimension>_on_demand_cost,<billing_dimension>_committed_cost,<billing_dimension>_total_cost) and the proportions (<billing_dimension>_percentage_in_org,<billing_dimension>_percentage_in_account). Use*to retrieve all fields. Example:infra_host_on_demand_cost,infra_host_percentage_in_accountTo obtain the complete list of active billing dimensions that can be used to replace<billing_dimension>in the field names, make a request to the Get active billing dimensions API. (required)- Returns:
- CompletableFuture<MonthlyCostAttributionResponse>
-
getMonthlyCostAttribution
public MonthlyCostAttributionResponse getMonthlyCostAttribution(OffsetDateTime startMonth, String fields, UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters parameters) throws ApiException Get Monthly Cost Attribution.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning in this month. (required)fields- Comma-separated list specifying cost types (e.g.,<billing_dimension>_on_demand_cost,<billing_dimension>_committed_cost,<billing_dimension>_total_cost) and the proportions (<billing_dimension>_percentage_in_org,<billing_dimension>_percentage_in_account). Use*to retrieve all fields. Example:infra_host_on_demand_cost,infra_host_percentage_in_accountTo obtain the complete list of active billing dimensions that can be used to replace<billing_dimension>in the field names, make a request to the Get active billing dimensions API. (required)parameters- Optional parameters for the request.- Returns:
- MonthlyCostAttributionResponse
- Throws:
ApiException- if fails to make API call
-
getMonthlyCostAttributionAsync
public CompletableFuture<MonthlyCostAttributionResponse> getMonthlyCostAttributionAsync(OffsetDateTime startMonth, String fields, UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters parameters) Get Monthly Cost Attribution.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning in this month. (required)fields- Comma-separated list specifying cost types (e.g.,<billing_dimension>_on_demand_cost,<billing_dimension>_committed_cost,<billing_dimension>_total_cost) and the proportions (<billing_dimension>_percentage_in_org,<billing_dimension>_percentage_in_account). Use*to retrieve all fields. Example:infra_host_on_demand_cost,infra_host_percentage_in_accountTo obtain the complete list of active billing dimensions that can be used to replace<billing_dimension>in the field names, make a request to the Get active billing dimensions API. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<MonthlyCostAttributionResponse>
-
getMonthlyCostAttributionWithHttpInfo
public ApiResponse<MonthlyCostAttributionResponse> getMonthlyCostAttributionWithHttpInfo(OffsetDateTime startMonth, String fields, UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters parameters) throws ApiException Get monthly cost attribution by tag across multi-org and single root-org accounts. Cost Attribution data for a given month becomes available no later than the 19th of the following month. This API endpoint is paginated. To make sure you receive all records, check if the value ofnext_record_idis set in the response. If it is, make another request and passnext_record_idas a parameter. Pseudo code example:response := GetMonthlyCostAttribution(start_month, end_month) cursor := response.metadata.pagination.next_record_id WHILE cursor != null BEGIN sleep(5 seconds) # Avoid running into rate limit response := GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor) cursor := response.metadata.pagination.next_record_id ENDThis endpoint is only accessible for parent-level organizations. This endpoint is not available in the Government (US1-FED) site.
- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning in this month. (required)fields- Comma-separated list specifying cost types (e.g.,<billing_dimension>_on_demand_cost,<billing_dimension>_committed_cost,<billing_dimension>_total_cost) and the proportions (<billing_dimension>_percentage_in_org,<billing_dimension>_percentage_in_account). Use*to retrieve all fields. Example:infra_host_on_demand_cost,infra_host_percentage_in_accountTo obtain the complete list of active billing dimensions that can be used to replace<billing_dimension>in the field names, make a request to the Get active billing dimensions API. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<MonthlyCostAttributionResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 429 Too many requests -
-
getMonthlyCostAttributionWithHttpInfoAsync
public CompletableFuture<ApiResponse<MonthlyCostAttributionResponse>> getMonthlyCostAttributionWithHttpInfoAsync(OffsetDateTime startMonth, String fields, UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters parameters) Get Monthly Cost Attribution.- Parameters:
startMonth- Datetime in ISO-8601 format, UTC, precise to month:[YYYY-MM]for cost beginning in this month. (required)fields- Comma-separated list specifying cost types (e.g.,<billing_dimension>_on_demand_cost,<billing_dimension>_committed_cost,<billing_dimension>_total_cost) and the proportions (<billing_dimension>_percentage_in_org,<billing_dimension>_percentage_in_account). Use*to retrieve all fields. Example:infra_host_on_demand_cost,infra_host_percentage_in_accountTo obtain the complete list of active billing dimensions that can be used to replace<billing_dimension>in the field names, make a request to the Get active billing dimensions API. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<MonthlyCostAttributionResponse>>
-
getProjectedCost
Get projected cost across your account.- Returns:
- ProjectedCostResponse
- Throws:
ApiException- if fails to make API call
-
getProjectedCostAsync
Get projected cost across your account.- Returns:
- CompletableFuture<ProjectedCostResponse>
-
getProjectedCost
public ProjectedCostResponse getProjectedCost(UsageMeteringApi.GetProjectedCostOptionalParameters parameters) throws ApiException Get projected cost across your account.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ProjectedCostResponse
- Throws:
ApiException- if fails to make API call
-
getProjectedCostAsync
public CompletableFuture<ProjectedCostResponse> getProjectedCostAsync(UsageMeteringApi.GetProjectedCostOptionalParameters parameters) Get projected cost across your account.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ProjectedCostResponse>
-
getProjectedCostWithHttpInfo
public ApiResponse<ProjectedCostResponse> getProjectedCostWithHttpInfo(UsageMeteringApi.GetProjectedCostOptionalParameters parameters) throws ApiException Get projected cost across multi-org and single root-org accounts. Projected cost data is only available for the current month and becomes available around the 12th of the month.This endpoint is only accessible for parent-level organizations.
- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<ProjectedCostResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 429 Too many requests -
-
getProjectedCostWithHttpInfoAsync
public CompletableFuture<ApiResponse<ProjectedCostResponse>> getProjectedCostWithHttpInfoAsync(UsageMeteringApi.GetProjectedCostOptionalParameters parameters) Get projected cost across your account.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<ProjectedCostResponse>>
-
getUsageApplicationSecurityMonitoring
@Deprecated public UsageApplicationSecurityMonitoringResponse getUsageApplicationSecurityMonitoring(OffsetDateTime startHr) throws ApiException Deprecated.Get hourly usage for application security.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)- Returns:
- UsageApplicationSecurityMonitoringResponse
- Throws:
ApiException- if fails to make API call
-
getUsageApplicationSecurityMonitoringAsync
@Deprecated public CompletableFuture<UsageApplicationSecurityMonitoringResponse> getUsageApplicationSecurityMonitoringAsync(OffsetDateTime startHr) Deprecated.Get hourly usage for application security.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)- Returns:
- CompletableFuture<UsageApplicationSecurityMonitoringResponse>
-
getUsageApplicationSecurityMonitoring
@Deprecated public UsageApplicationSecurityMonitoringResponse getUsageApplicationSecurityMonitoring(OffsetDateTime startHr, UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters parameters) throws ApiException Deprecated.Get hourly usage for application security.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)parameters- Optional parameters for the request.- Returns:
- UsageApplicationSecurityMonitoringResponse
- Throws:
ApiException- if fails to make API call
-
getUsageApplicationSecurityMonitoringAsync
@Deprecated public CompletableFuture<UsageApplicationSecurityMonitoringResponse> getUsageApplicationSecurityMonitoringAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters parameters) Deprecated.Get hourly usage for application security.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<UsageApplicationSecurityMonitoringResponse>
-
getUsageApplicationSecurityMonitoringWithHttpInfo
@Deprecated public ApiResponse<UsageApplicationSecurityMonitoringResponse> getUsageApplicationSecurityMonitoringWithHttpInfo(OffsetDateTime startHr, UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters parameters) throws ApiException Deprecated.Get hourly usage for application security . Note: This endpoint has been deprecated. Hourly usage data for all products is now available in the Get hourly usage by product family API- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<UsageApplicationSecurityMonitoringResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 429 Too many requests -
-
getUsageApplicationSecurityMonitoringWithHttpInfoAsync
@Deprecated public CompletableFuture<ApiResponse<UsageApplicationSecurityMonitoringResponse>> getUsageApplicationSecurityMonitoringWithHttpInfoAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters parameters) Deprecated.Get hourly usage for application security.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<UsageApplicationSecurityMonitoringResponse>>
-
getUsageAttributionTypes
Get usage attribution types.- Returns:
- UsageAttributionTypesResponse
- Throws:
ApiException- if fails to make API call
-
getUsageAttributionTypesAsync
Get usage attribution types.- Returns:
- CompletableFuture<UsageAttributionTypesResponse>
-
getUsageAttributionTypesWithHttpInfo
public ApiResponse<UsageAttributionTypesResponse> getUsageAttributionTypesWithHttpInfo() throws ApiExceptionGet usage attribution types.- Returns:
- ApiResponse<UsageAttributionTypesResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - User is not authorized - 429 Too many requests -
-
getUsageAttributionTypesWithHttpInfoAsync
public CompletableFuture<ApiResponse<UsageAttributionTypesResponse>> getUsageAttributionTypesWithHttpInfoAsync()Get usage attribution types.- Returns:
- CompletableFuture<ApiResponse<UsageAttributionTypesResponse>>
-
getUsageLambdaTracedInvocations
@Deprecated public UsageLambdaTracedInvocationsResponse getUsageLambdaTracedInvocations(OffsetDateTime startHr) throws ApiException Deprecated.Get hourly usage for Lambda traced invocations.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)- Returns:
- UsageLambdaTracedInvocationsResponse
- Throws:
ApiException- if fails to make API call
-
getUsageLambdaTracedInvocationsAsync
@Deprecated public CompletableFuture<UsageLambdaTracedInvocationsResponse> getUsageLambdaTracedInvocationsAsync(OffsetDateTime startHr) Deprecated.Get hourly usage for Lambda traced invocations.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)- Returns:
- CompletableFuture<UsageLambdaTracedInvocationsResponse>
-
getUsageLambdaTracedInvocations
@Deprecated public UsageLambdaTracedInvocationsResponse getUsageLambdaTracedInvocations(OffsetDateTime startHr, UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters parameters) throws ApiException Deprecated.Get hourly usage for Lambda traced invocations.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)parameters- Optional parameters for the request.- Returns:
- UsageLambdaTracedInvocationsResponse
- Throws:
ApiException- if fails to make API call
-
getUsageLambdaTracedInvocationsAsync
@Deprecated public CompletableFuture<UsageLambdaTracedInvocationsResponse> getUsageLambdaTracedInvocationsAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters parameters) Deprecated.Get hourly usage for Lambda traced invocations.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<UsageLambdaTracedInvocationsResponse>
-
getUsageLambdaTracedInvocationsWithHttpInfo
@Deprecated public ApiResponse<UsageLambdaTracedInvocationsResponse> getUsageLambdaTracedInvocationsWithHttpInfo(OffsetDateTime startHr, UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters parameters) throws ApiException Deprecated.Get hourly usage for Lambda traced invocations. Note: This endpoint has been deprecated.. Hourly usage data for all products is now available in the Get hourly usage by product family API- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<UsageLambdaTracedInvocationsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 429 Too many requests -
-
getUsageLambdaTracedInvocationsWithHttpInfoAsync
@Deprecated public CompletableFuture<ApiResponse<UsageLambdaTracedInvocationsResponse>> getUsageLambdaTracedInvocationsWithHttpInfoAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters parameters) Deprecated.Get hourly usage for Lambda traced invocations.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<UsageLambdaTracedInvocationsResponse>>
-
getUsageObservabilityPipelines
@Deprecated public UsageObservabilityPipelinesResponse getUsageObservabilityPipelines(OffsetDateTime startHr) throws ApiException Deprecated.Get hourly usage for observability pipelines.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)- Returns:
- UsageObservabilityPipelinesResponse
- Throws:
ApiException- if fails to make API call
-
getUsageObservabilityPipelinesAsync
@Deprecated public CompletableFuture<UsageObservabilityPipelinesResponse> getUsageObservabilityPipelinesAsync(OffsetDateTime startHr) Deprecated.Get hourly usage for observability pipelines.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)- Returns:
- CompletableFuture<UsageObservabilityPipelinesResponse>
-
getUsageObservabilityPipelines
@Deprecated public UsageObservabilityPipelinesResponse getUsageObservabilityPipelines(OffsetDateTime startHr, UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters parameters) throws ApiException Deprecated.Get hourly usage for observability pipelines.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)parameters- Optional parameters for the request.- Returns:
- UsageObservabilityPipelinesResponse
- Throws:
ApiException- if fails to make API call
-
getUsageObservabilityPipelinesAsync
@Deprecated public CompletableFuture<UsageObservabilityPipelinesResponse> getUsageObservabilityPipelinesAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters parameters) Deprecated.Get hourly usage for observability pipelines.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<UsageObservabilityPipelinesResponse>
-
getUsageObservabilityPipelinesWithHttpInfo
@Deprecated public ApiResponse<UsageObservabilityPipelinesResponse> getUsageObservabilityPipelinesWithHttpInfo(OffsetDateTime startHr, UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters parameters) throws ApiException Deprecated.Get hourly usage for observability pipelines. Note: This endpoint has been deprecated. Hourly usage data for all products is now available in the Get hourly usage by product family API- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<UsageObservabilityPipelinesResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 429 Too many requests -
-
getUsageObservabilityPipelinesWithHttpInfoAsync
@Deprecated public CompletableFuture<ApiResponse<UsageObservabilityPipelinesResponse>> getUsageObservabilityPipelinesWithHttpInfoAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters parameters) Deprecated.Get hourly usage for observability pipelines.- Parameters:
startHr- Datetime in ISO-8601 format, UTC, precise to hour:[YYYY-MM-DDThh]for usage beginning at this hour. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<UsageObservabilityPipelinesResponse>>
-
getUsageSummaryAvailableFields
Get available fields for usage summary.- Returns:
- UsageSummaryAvailableFieldsResponse
- Throws:
ApiException- if fails to make API call
-
getUsageSummaryAvailableFieldsAsync
Get available fields for usage summary.- Returns:
- CompletableFuture<UsageSummaryAvailableFieldsResponse>
-
getUsageSummaryAvailableFieldsWithHttpInfo
public ApiResponse<UsageSummaryAvailableFieldsResponse> getUsageSummaryAvailableFieldsWithHttpInfo() throws ApiExceptionList the field names returned byGET /api/v1/usage/summaryat each of its three response levels. Each list contains every key the data endpoint emits—both typed fields declared in the OpenAPI spec and untyped keys exposed throughadditionalProperties(the latter used for billing dimensions and usage types added after the v1 schema freeze).This endpoint is only accessible for parent-level organizations.
Go example:
```go fields, _, err := api.GetUsageSummaryAvailableFields(ctx) attr := fields.Data.GetAttributes()
// resp is the *UsageSummaryResponse returned by api.GetUsageSummary(ctx, ...) // Layer 1: UsageSummaryResponse for , key := range attr.GetResponseFields() { if val, ok := resp.AdditionalProperties[key]; ok { fmt.Println(key, val.(json.Number)) } } // Layer 2: UsageSummaryDate (per month) for , date := range resp.GetUsage() { for , key := range attr.GetDateFields() { if val, ok := date.AdditionalProperties[key]; ok { fmt.Println(key, val.(json.Number)) } } // Layer 3: UsageSummaryDateOrg (per org per month) for , org := range date.GetOrgs() { for _, key := range attr.GetDateOrgFields() { if val, ok := org.AdditionalProperties[key]; ok { fmt.Println(key, val.(json.Number)) } } } } ```
- Returns:
- ApiResponse<UsageSummaryAvailableFieldsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK. - 403 Forbidden - User is not authorized. - 429 Too many requests. -
-
getUsageSummaryAvailableFieldsWithHttpInfoAsync
public CompletableFuture<ApiResponse<UsageSummaryAvailableFieldsResponse>> getUsageSummaryAvailableFieldsWithHttpInfoAsync()Get available fields for usage summary.- Returns:
- CompletableFuture<ApiResponse<UsageSummaryAvailableFieldsResponse>>
-
listQuotas
List usage quotas.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)- Returns:
- UsageQuotasListResponse
- Throws:
ApiException- if fails to make API call
-
listQuotasAsync
List usage quotas.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)- Returns:
- CompletableFuture<UsageQuotasListResponse>
-
listQuotas
public UsageQuotasListResponse listQuotas(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters) throws ApiException List usage quotas.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)parameters- Optional parameters for the request.- Returns:
- UsageQuotasListResponse
- Throws:
ApiException- if fails to make API call
-
listQuotasAsync
public CompletableFuture<UsageQuotasListResponse> listQuotasAsync(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters) List usage quotas.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<UsageQuotasListResponse>
-
listQuotasWithPagination
List usage quotas.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)- Returns:
- PaginationIterable<UsageQuotaResponseData>
-
listQuotasWithPagination
public PaginationIterable<UsageQuotaResponseData> listQuotasWithPagination(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters) List usage quotas.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)- Returns:
- UsageQuotasListResponse
-
listQuotasWithHttpInfo
public ApiResponse<UsageQuotasListResponse> listQuotasWithHttpInfo(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters) throws ApiException Lists usage quotas for the caller's organization in a quota namespace. You can optionally include descendant organizations in the same datacenter as the caller. Requires thebilling_readorbilling_editpermission.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<UsageQuotasListResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - 429 Too many requests -
-
listQuotasWithHttpInfoAsync
public CompletableFuture<ApiResponse<UsageQuotasListResponse>> listQuotasWithHttpInfoAsync(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters) List usage quotas.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<UsageQuotasListResponse>>
-
updateQuota
public UsageQuotaResponse updateQuota(String quotaNamespace, String id, UsageQuotaUpdateRequest body) throws ApiException Update a usage quota.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)id- The opaque quota identifier returned by a previous list or create request. Clients must pass this value verbatim. (required)body- The usage quota fields to update. Omitting an attribute leaves its current value unchanged. (required)- Returns:
- UsageQuotaResponse
- Throws:
ApiException- if fails to make API call
-
updateQuotaAsync
public CompletableFuture<UsageQuotaResponse> updateQuotaAsync(String quotaNamespace, String id, UsageQuotaUpdateRequest body) Update a usage quota.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)id- The opaque quota identifier returned by a previous list or create request. Clients must pass this value verbatim. (required)body- The usage quota fields to update. Omitting an attribute leaves its current value unchanged. (required)- Returns:
- CompletableFuture<UsageQuotaResponse>
-
updateQuotaWithHttpInfo
public ApiResponse<UsageQuotaResponse> updateQuotaWithHttpInfo(String quotaNamespace, String id, UsageQuotaUpdateRequest body) throws ApiException Updates the supplied fields on a usage quota and leaves omitted fields unchanged. The quota must belong to the caller's organization or one of its descendants, and its opaque identifier must belong to the requested quota namespace. Requires thebilling_editpermission.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)id- The opaque quota identifier returned by a previous list or create request. Clients must pass this value verbatim. (required)body- The usage quota fields to update. Omitting an attribute leaves its current value unchanged. (required)- Returns:
- ApiResponse<UsageQuotaResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request. Returned if the request is malformed, or if the `id` in the request body does not match the `id` in the request path. - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
updateQuotaWithHttpInfoAsync
public CompletableFuture<ApiResponse<UsageQuotaResponse>> updateQuotaWithHttpInfoAsync(String quotaNamespace, String id, UsageQuotaUpdateRequest body) Update a usage quota.- Parameters:
quotaNamespace- The product-specific namespace whose usage quotas are being managed. (required)id- The opaque quota identifier returned by a previous list or create request. Clients must pass this value verbatim. (required)body- The usage quota fields to update. Omitting an attribute leaves its current value unchanged. (required)- Returns:
- CompletableFuture<ApiResponse<UsageQuotaResponse>>
-