Storage Insights V1 API - Class Google::Cloud::StorageInsights::V1::ReportDetail (v0.5.0)

Reference documentation and code samples for the Storage Insights V1 API class Google::Cloud::StorageInsights::V1::ReportDetail.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs

Returns

(::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs

#name

def name() -> ::String

Returns

(::String) — Name of resource. It will be of form projects/

#name=

def name=(value) -> ::String

Parameter

value (::String) — Name of resource. It will be of form projects/

Returns

(::String) — Name of resource. It will be of form projects/

#report_metrics

def report_metrics() -> ::Google::Cloud::StorageInsights::V1::ReportDetail::Metrics

Returns

(::Google::Cloud::StorageInsights::V1::ReportDetail::Metrics) — Metrics of the report.

#report_metrics=

def report_metrics=(value) -> ::Google::Cloud::StorageInsights::V1::ReportDetail::Metrics

Parameter

value (::Google::Cloud::StorageInsights::V1::ReportDetail::Metrics) — Metrics of the report.

Returns

(::Google::Cloud::StorageInsights::V1::ReportDetail::Metrics) — Metrics of the report.

#report_path_prefix

def report_path_prefix() -> ::String

Returns

(::String) — 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_.

#report_path_prefix=

def report_path_prefix=(value) -> ::String

Parameter

value (::String) — 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_.

Returns

(::String) — 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_.

#shards_count

def shards_count() -> ::Integer

Returns

(::Integer) — Total shards generated for the report.

#shards_count=

def shards_count=(value) -> ::Integer

Parameter

value (::Integer) — Total shards generated for the report.

Returns

(::Integer) — Total shards generated for the report.

#snapshot_time

def snapshot_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — The snapshot time. All the report data is referenced at this point of time.

#snapshot_time=

def snapshot_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — The snapshot time. All the report data is referenced at this point of time.

Returns

(::Google::Protobuf::Timestamp) — The snapshot time. All the report data is referenced at this point of time.

#status

def status() -> ::Google::Rpc::Status

Returns

(::Google::Rpc::Status) — Status of the ReportDetail.

#status=

def status=(value) -> ::Google::Rpc::Status

Parameter

value (::Google::Rpc::Status) — Status of the ReportDetail.

Returns

(::Google::Rpc::Status) — Status of the ReportDetail.

#target_datetime

def target_datetime() -> ::Google::Type::DateTime

Returns

(::Google::Type::DateTime) — The date for which report is generated. The time part of target_datetime will be zero till we support multiple reports per day.

#target_datetime=

def target_datetime=(value) -> ::Google::Type::DateTime

Parameter

value (::Google::Type::DateTime) — The date for which report is generated. The time part of target_datetime will be zero till we support multiple reports per day.

Returns

(::Google::Type::DateTime) — The date for which report is generated. The time part of target_datetime will be zero till we support multiple reports per day.