Interface ReportOrBuilder (0.1.0)

public interface ReportOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDimensions(int index)

public abstract String getDimensions(int index)

Required. A list of dimensions to include in the report. Supported values:

project
application
service_or_workload
resource
resource_type
location
product_display_name
sku
month
day
hour

To aggregate results by time, specify at least one time dimension (month, day, or hour). All time dimensions use Pacific Time, respect Daylight Saving Time (DST), and follow these ISO 8601 formats:
month: YYYY-MM (e.g., 2024-01)
day: YYYY-MM-DD (e.g., 2024-01-10)
hour: YYYY-MM-DDTHH (e.g., 2024-01-10T00)

If the time range filter does not align with the selected time dimension, the range is expanded to encompass the full period of the finest-grained time dimension.

For example, if the filter is 2026-01-10 through 2026-01-12 and the month dimension is selected, the effective time range expands to include all of January (2026-01-01 to 2026-02-01).

repeated string dimensions = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The dimensions at the given index.

getDimensionsBytes(int index)

public abstract ByteString getDimensionsBytes(int index)

Required. A list of dimensions to include in the report. Supported values:

project
application
service_or_workload
resource
resource_type
location
product_display_name
sku
month
day
hour

To aggregate results by time, specify at least one time dimension (month, day, or hour). All time dimensions use Pacific Time, respect Daylight Saving Time (DST), and follow these ISO 8601 formats:
month: YYYY-MM (e.g., 2024-01)
day: YYYY-MM-DD (e.g., 2024-01-10)
hour: YYYY-MM-DDTHH (e.g., 2024-01-10T00)

If the time range filter does not align with the selected time dimension, the range is expanded to encompass the full period of the finest-grained time dimension.

For example, if the filter is 2026-01-10 through 2026-01-12 and the month dimension is selected, the effective time range expands to include all of January (2026-01-01 to 2026-02-01).

repeated string dimensions = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the dimensions at the given index.

getDimensionsCount()

public abstract int getDimensionsCount()

Required. A list of dimensions to include in the report. Supported values:

project
application
service_or_workload
resource
resource_type
location
product_display_name
sku
month
day
hour

To aggregate results by time, specify at least one time dimension (month, day, or hour). All time dimensions use Pacific Time, respect Daylight Saving Time (DST), and follow these ISO 8601 formats:
month: YYYY-MM (e.g., 2024-01)
day: YYYY-MM-DD (e.g., 2024-01-10)
hour: YYYY-MM-DDTHH (e.g., 2024-01-10T00)

If the time range filter does not align with the selected time dimension, the range is expanded to encompass the full period of the finest-grained time dimension.

For example, if the filter is 2026-01-10 through 2026-01-12 and the month dimension is selected, the effective time range expands to include all of January (2026-01-01 to 2026-02-01).

repeated string dimensions = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`	The count of dimensions.

getDimensionsList()

public abstract List<String> getDimensionsList()

Required. A list of dimensions to include in the report. Supported values:

project
application
service_or_workload
resource
resource_type
location
product_display_name
sku
month
day
hour

To aggregate results by time, specify at least one time dimension (month, day, or hour). All time dimensions use Pacific Time, respect Daylight Saving Time (DST), and follow these ISO 8601 formats:
month: YYYY-MM (e.g., 2024-01)
day: YYYY-MM-DD (e.g., 2024-01-10)
hour: YYYY-MM-DDTHH (e.g., 2024-01-10T00)

If the time range filter does not align with the selected time dimension, the range is expanded to encompass the full period of the finest-grained time dimension.

For example, if the filter is 2026-01-10 through 2026-01-12 and the month dimension is selected, the effective time range expands to include all of January (2026-01-01 to 2026-02-01).

repeated string dimensions = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<String>`	A list containing the dimensions.

getExpirationCase()

public abstract Report.ExpirationCase getExpirationCase()

Returns
Type	Description
`Report.ExpirationCase`

getExpireTime()

public abstract Timestamp getExpireTime()

Output only. Timestamp in UTC of when this report expires. Once the report expires, it will no longer be accessible and the report's underlying data will be deleted.

.google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The expireTime.

getExpireTimeOrBuilder()

public abstract TimestampOrBuilder getExpireTimeOrBuilder()

Output only. Timestamp in UTC of when this report expires. Once the report expires, it will no longer be accessible and the report's underlying data will be deleted.

.google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getFilter()

public abstract String getFilter()

Optional. A Common Expression Language (CEL) expression used to filter the data for the report.

Predicates may refer to any dimension. Filtering must conform to these constraints:

All string field predicates must use exact string matches.
Multiple predicates referring to the same string field must be joined using the logical OR operator ('||').
All other predicates must be joined using the logical AND operator (&&).
A predicate on a time dimension (e.g., day) specifying the start time must use a greater-than-or-equal-to comparison (>=).
A predicate on a time dimension specifying the end time must use a less-than comparison (<).

Examples:
Filter by a specific resource type: "resource_type == 'compute.googleapis.com/Instance'"
Filter data points that fall within a specific absolute time interval: "hour >= timestamp('2024-01-01T00:00:00Z') && hour < timestamp('2024-02-01T00:00:00Z')"
Filter data points that fall within the past 72 hours: "hour >= now - duration('72h')"
Combine string predicate with time interval predicate: "(location == 'us-east1' || location == 'us-west1') && hour >= timestamp('2023-12-01T00:00:00Z') && hour < timestamp('2024-02-01T00:00:00Z')"

If the filter omits time dimensions (month, day, hour), the report defaults to a 7-day range ending at the previous Pacific Time midnight, with Daylight Saving Time (DST) applied.

For example, if the current Pacific Time is 2026-01-05T12:00:00, the default range is 2025-12-29T00:00:00 to 2026-01-05T00:00:00 Pacific time.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Optional. A Common Expression Language (CEL) expression used to filter the data for the report.

Predicates may refer to any dimension. Filtering must conform to these constraints:

All string field predicates must use exact string matches.
Multiple predicates referring to the same string field must be joined using the logical OR operator ('||').
All other predicates must be joined using the logical AND operator (&&).
A predicate on a time dimension (e.g., day) specifying the start time must use a greater-than-or-equal-to comparison (>=).
A predicate on a time dimension specifying the end time must use a less-than comparison (<).

Examples:
Filter by a specific resource type: "resource_type == 'compute.googleapis.com/Instance'"
Filter data points that fall within a specific absolute time interval: "hour >= timestamp('2024-01-01T00:00:00Z') && hour < timestamp('2024-02-01T00:00:00Z')"
Filter data points that fall within the past 72 hours: "hour >= now - duration('72h')"
Combine string predicate with time interval predicate: "(location == 'us-east1' || location == 'us-west1') && hour >= timestamp('2023-12-01T00:00:00Z') && hour < timestamp('2024-02-01T00:00:00Z')"

If the filter omits time dimensions (month, day, hour), the report defaults to a 7-day range ending at the previous Pacific Time midnight, with Daylight Saving Time (DST) applied.

For example, if the current Pacific Time is 2026-01-05T12:00:00, the default range is 2025-12-29T00:00:00 to 2026-01-05T00:00:00 Pacific time.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for filter.

getMetrics(int index)

public abstract String getMetrics(int index)

Required. A list of metrics to include in the report. Supported values:

cost
cpu_mean_utilization
cpu_usage_core_seconds
cpu_allocation_core_seconds
cpu_p95_utilization
memory_mean_utilization
memory_usage_byte_seconds
memory_allocation_byte_seconds
memory_p95_utilization

repeated string metrics = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The metrics at the given index.

getMetricsBytes(int index)

public abstract ByteString getMetricsBytes(int index)

Required. A list of metrics to include in the report. Supported values:

cost
cpu_mean_utilization
cpu_usage_core_seconds
cpu_allocation_core_seconds
cpu_p95_utilization
memory_mean_utilization
memory_usage_byte_seconds
memory_allocation_byte_seconds
memory_p95_utilization

repeated string metrics = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the metrics at the given index.

getMetricsCount()

public abstract int getMetricsCount()

Required. A list of metrics to include in the report. Supported values:

cost
cpu_mean_utilization
cpu_usage_core_seconds
cpu_allocation_core_seconds
cpu_p95_utilization
memory_mean_utilization
memory_usage_byte_seconds
memory_allocation_byte_seconds
memory_p95_utilization

repeated string metrics = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`	The count of metrics.

getMetricsList()

public abstract List<String> getMetricsList()

Required. A list of metrics to include in the report. Supported values:

cost
cpu_mean_utilization
cpu_usage_core_seconds
cpu_allocation_core_seconds
cpu_p95_utilization
memory_mean_utilization
memory_usage_byte_seconds
memory_allocation_byte_seconds
memory_p95_utilization

repeated string metrics = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<String>`	A list containing the metrics.

getName()

public abstract String getName()

Identifier. The name of this report.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The name of this report.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
`ByteString`	The bytes for name.

getScopes(int index)

public abstract Scope getScopes(int index)

Optional. The resource containers for which to fetch data. Default is the project specified in the report's parent.