Class ReportDetail (0.41.0) 

public final class ReportDetail extends GeneratedMessageV3 implements ReportDetailOrBuilder

Message describing ReportDetail object. ReportDetail represents metadata of generated reports for a ReportConfig. Next ID: 10

Protobuf type google.cloud.storageinsights.v1.ReportDetail

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ReportDetail

Static Fields

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REPORT_METRICS_FIELD_NUMBER

public static final int REPORT_METRICS_FIELD_NUMBER
Field Value
Type Description
int

REPORT_PATH_PREFIX_FIELD_NUMBER

public static final int REPORT_PATH_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

SHARDS_COUNT_FIELD_NUMBER

public static final int SHARDS_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SNAPSHOT_TIME_FIELD_NUMBER

public static final int SNAPSHOT_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TARGET_DATETIME_FIELD_NUMBER

public static final int TARGET_DATETIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReportDetail getDefaultInstance()
Returns
Type Description
ReportDetail

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ReportDetail.Builder newBuilder()
Returns
Type Description
ReportDetail.Builder

newBuilder(ReportDetail prototype)

public static ReportDetail.Builder newBuilder(ReportDetail prototype)
Parameter
Name Description
prototype ReportDetail
Returns
Type Description
ReportDetail.Builder

parseDelimitedFrom(InputStream input)

public static ReportDetail parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReportDetail
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportDetail parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportDetail
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ReportDetail parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ReportDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReportDetail parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReportDetail parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReportDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReportDetail parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReportDetail parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReportDetail
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportDetail parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportDetail
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ReportDetail parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReportDetail
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportDetail parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportDetail
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ReportDetail parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReportDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReportDetail parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportDetail
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ReportDetail> parser()
Returns
Type Description
Parser<ReportDetail>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 5;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ReportDetail getDefaultInstanceForType()
Returns
Type Description
ReportDetail

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs

map<string, string> labels = 5;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs

map<string, string> labels = 5;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs

map<string, string> labels = 5;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs

map<string, string> labels = 5;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Name of resource. It will be of form projects/<project>/locations/<location>/reportConfigs/<report-config-id>/reportDetails/<report-detail-id>.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of resource. It will be of form projects/<project>/locations/<location>/reportConfigs/<report-config-id>/reportDetails/<report-detail-id>.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<ReportDetail> getParserForType()
Returns
Type Description
Parser<ReportDetail>
Overrides

getReportMetrics()

public ReportDetail.Metrics getReportMetrics()

Metrics of the report.

.google.cloud.storageinsights.v1.ReportDetail.Metrics report_metrics = 7;

Returns
Type Description
ReportDetail.Metrics

The reportMetrics.

getReportMetricsOrBuilder()

public ReportDetail.MetricsOrBuilder getReportMetricsOrBuilder()

Metrics of the report.

.google.cloud.storageinsights.v1.ReportDetail.Metrics report_metrics = 7;

Returns
Type Description
ReportDetail.MetricsOrBuilder

getReportPathPrefix()

public String getReportPathPrefix()

Prefix of the object name of each report's shard. This will have full prefix except the "extension" and "shard_id". For example, if the destination_path is {{report-config-id}}/dt={{datetime}}, the shard object name would be gs://my-insights/1A34-F2E456-12B456-1C3D/dt=2022-05-20T06:35/1A34-F2E456-12B456-1C3D_2022-05-20T06:35_5.csv and the value of report_path_prefix field would be gs://my-insights/1A34-F2E456-12B456-1C3D/dt=2022-05-20T06:35/1A34-F2E456-12B456-1C3D_2022-05-20T06:35_.

string report_path_prefix = 8;

Returns
Type Description
String

The reportPathPrefix.

getReportPathPrefixBytes()

public ByteString getReportPathPrefixBytes()

Prefix of the object name of each report's shard. This will have full prefix except the "extension" and "shard_id". For example, if the destination_path is {{report-config-id}}/dt={{datetime}}, the shard object name would be gs://my-insights/1A34-F2E456-12B456-1C3D/dt=2022-05-20T06:35/1A34-F2E456-12B456-1C3D_2022-05-20T06:35_5.csv and the value of report_path_prefix field would be gs://my-insights/1A34-F2E456-12B456-1C3D/dt=2022-05-20T06:35/1A34-F2E456-12B456-1C3D_2022-05-20T06:35_.

string report_path_prefix = 8;

Returns
Type Description
ByteString

The bytes for reportPathPrefix.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShardsCount()

public long getShardsCount()

Total shards generated for the report.

int64 shards_count = 9;

Returns
Type Description
long

The shardsCount.

getSnapshotTime()

public Timestamp getSnapshotTime()

The snapshot time. All the report data is referenced at this point of time.

.google.protobuf.Timestamp snapshot_time = 2;

Returns
Type Description
Timestamp

The snapshotTime.

getSnapshotTimeOrBuilder()

public TimestampOrBuilder getSnapshotTimeOrBuilder()

The snapshot time. All the report data is referenced at this point of time.

.google.protobuf.Timestamp snapshot_time = 2;

Returns
Type Description
TimestampOrBuilder

getStatus()

public Status getStatus()

Status of the ReportDetail.

.google.rpc.Status status = 4;

Returns
Type Description
com.google.rpc.Status

The status.

getStatusOrBuilder()

public StatusOrBuilder getStatusOrBuilder()

Status of the ReportDetail.

.google.rpc.Status status = 4;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getTargetDatetime()

public DateTime getTargetDatetime()

The date for which report is generated. The time part of target_datetime will be zero till we support multiple reports per day.

.google.type.DateTime target_datetime = 6;

Returns
Type Description
com.google.type.DateTime

The targetDatetime.

getTargetDatetimeOrBuilder()

public DateTimeOrBuilder getTargetDatetimeOrBuilder()

The date for which report is generated. The time part of target_datetime will be zero till we support multiple reports per day.

.google.type.DateTime target_datetime = 6;

Returns
Type Description
com.google.type.DateTimeOrBuilder

hasReportMetrics()

public boolean hasReportMetrics()

Metrics of the report.

.google.cloud.storageinsights.v1.ReportDetail.Metrics report_metrics = 7;

Returns
Type Description
boolean

Whether the reportMetrics field is set.

hasSnapshotTime()

public boolean hasSnapshotTime()

The snapshot time. All the report data is referenced at this point of time.

.google.protobuf.Timestamp snapshot_time = 2;

Returns
Type Description
boolean

Whether the snapshotTime field is set.

hasStatus()

public boolean hasStatus()

Status of the ReportDetail.

.google.rpc.Status status = 4;

Returns
Type Description
boolean

Whether the status field is set.

hasTargetDatetime()

public boolean hasTargetDatetime()

The date for which report is generated. The time part of target_datetime will be zero till we support multiple reports per day.

.google.type.DateTime target_datetime = 6;

Returns
Type Description
boolean

Whether the targetDatetime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ReportDetail.Builder newBuilderForType()
Returns
Type Description
ReportDetail.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReportDetail.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ReportDetail.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ReportDetail.Builder toBuilder()
Returns
Type Description
ReportDetail.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException