public final class Report extends GeneratedMessage implements ReportOrBuilderA configuration that defines the parameters for the data represented by a report.
Protobuf type google.cloud.appoptimize.v1beta.Report
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ReportImplements
ReportOrBuilderStatic Fields
DIMENSIONS_FIELD_NUMBER
public static final int DIMENSIONS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EXPIRE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
METRICS_FIELD_NUMBER
public static final int METRICS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SCOPES_FIELD_NUMBER
public static final int SCOPES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Report getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Report |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Report.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Report.Builder |
|
newBuilder(Report prototype)
public static Report.Builder newBuilder(Report prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Report |
| Returns | |
|---|---|
| Type | Description |
Report.Builder |
|
parseDelimitedFrom(InputStream input)
public static Report parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Report |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Report parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Report |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Report parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Report |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Report parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Report |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Report parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Report |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Report parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Report |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Report parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Report |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Report parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Report |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Report parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Report |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Report parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Report |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Report parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Report |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Report parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Report |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Report> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Report> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public Report getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Report |
|
getDimensions(int index)
public String getDimensions(int index)Required. A list of dimensions to include in the report. Supported values:
projectapplicationservice_or_workloadresourceresource_typelocationproduct_display_nameskumonthdayhourTo aggregate results by time, specify at least one time dimension (
month,day, orhour). 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-10through2026-01-12and themonthdimension is selected, the effective time range expands to include all of January (2026-01-01to2026-02-01).
repeated string dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The dimensions at the given index. |
getDimensionsBytes(int index)
public ByteString getDimensionsBytes(int index)Required. A list of dimensions to include in the report. Supported values:
projectapplicationservice_or_workloadresourceresource_typelocationproduct_display_nameskumonthdayhourTo aggregate results by time, specify at least one time dimension (
month,day, orhour). 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-10through2026-01-12and themonthdimension is selected, the effective time range expands to include all of January (2026-01-01to2026-02-01).
repeated string dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the dimensions at the given index. |
getDimensionsCount()
public int getDimensionsCount()Required. A list of dimensions to include in the report. Supported values:
projectapplicationservice_or_workloadresourceresource_typelocationproduct_display_nameskumonthdayhourTo aggregate results by time, specify at least one time dimension (
month,day, orhour). 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-10through2026-01-12and themonthdimension is selected, the effective time range expands to include all of January (2026-01-01to2026-02-01).
repeated string dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The count of dimensions. |
getDimensionsList()
public ProtocolStringList getDimensionsList()Required. A list of dimensions to include in the report. Supported values:
projectapplicationservice_or_workloadresourceresource_typelocationproduct_display_nameskumonthdayhourTo aggregate results by time, specify at least one time dimension (
month,day, orhour). 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-10through2026-01-12and themonthdimension is selected, the effective time range expands to include all of January (2026-01-01to2026-02-01).
repeated string dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the dimensions. |
getExpirationCase()
public Report.ExpirationCase getExpirationCase()| Returns | |
|---|---|
| Type | Description |
Report.ExpirationCase |
|
getExpireTime()
public 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 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 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 is2025-12-29T00:00:00to2026-01-05T00:00:00Pacific time.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public 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 is2025-12-29T00:00:00to2026-01-05T00:00:00Pacific time.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getMetrics(int index)
public String getMetrics(int index)Required. A list of metrics to include in the report. Supported values:
costcpu_mean_utilizationcpu_usage_core_secondscpu_allocation_core_secondscpu_p95_utilizationmemory_mean_utilizationmemory_usage_byte_secondsmemory_allocation_byte_secondsmemory_p95_utilization
repeated string metrics = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The metrics at the given index. |
getMetricsBytes(int index)
public ByteString getMetricsBytes(int index)Required. A list of metrics to include in the report. Supported values:
costcpu_mean_utilizationcpu_usage_core_secondscpu_allocation_core_secondscpu_p95_utilizationmemory_mean_utilizationmemory_usage_byte_secondsmemory_allocation_byte_secondsmemory_p95_utilization
repeated string metrics = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the metrics at the given index. |
getMetricsCount()
public int getMetricsCount()Required. A list of metrics to include in the report. Supported values:
costcpu_mean_utilizationcpu_usage_core_secondscpu_allocation_core_secondscpu_p95_utilizationmemory_mean_utilizationmemory_usage_byte_secondsmemory_allocation_byte_secondsmemory_p95_utilization
repeated string metrics = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The count of metrics. |
getMetricsList()
public ProtocolStringList getMetricsList()Required. A list of metrics to include in the report. Supported values:
costcpu_mean_utilizationcpu_usage_core_secondscpu_allocation_core_secondscpu_p95_utilizationmemory_mean_utilizationmemory_usage_byte_secondsmemory_allocation_byte_secondsmemory_p95_utilization
repeated string metrics = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the metrics. |
getName()
public String getName()Identifier. The name of this report.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()Identifier. The name of this report.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getParserForType()
public Parser<Report> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Report> |
|
getScopes(int index)
public Scope getScopes(int index)Optional. The resource containers for which to fetch data. Default is the project specified in the report's parent.
repeated .google.cloud.appoptimize.v1beta.Scope scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Scope |
|
getScopesCount()
public int getScopesCount()Optional. The resource containers for which to fetch data. Default is the project specified in the report's parent.
repeated .google.cloud.appoptimize.v1beta.Scope scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getScopesList()
public List<Scope> getScopesList()Optional. The resource containers for which to fetch data. Default is the project specified in the report's parent.
repeated .google.cloud.appoptimize.v1beta.Scope scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Scope> |
|
getScopesOrBuilder(int index)
public ScopeOrBuilder getScopesOrBuilder(int index)Optional. The resource containers for which to fetch data. Default is the project specified in the report's parent.
repeated .google.cloud.appoptimize.v1beta.Scope scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ScopeOrBuilder |
|
getScopesOrBuilderList()
public List<? extends ScopeOrBuilder> getScopesOrBuilderList()Optional. The resource containers for which to fetch data. Default is the project specified in the report's parent.
repeated .google.cloud.appoptimize.v1beta.Scope scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.appoptimize.v1beta.ScopeOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hasExpireTime()
public boolean hasExpireTime()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 |
boolean |
Whether the expireTime field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Report.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Report.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Report.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Report.Builder |
|
toBuilder()
public Report.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Report.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|