Reference documentation and code samples for the Google Cloud Storage Insights V1 Client class ReportDetail.
Message describing ReportDetail object. ReportDetail represents metadata of generated reports for a ReportConfig.
Next ID: 10
Generated from protobuf message google.cloud.storageinsights.v1.ReportDetail
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Name of resource. It will be of form projects/
|
↳ snapshot_time |
Google\Protobuf\Timestamp
The snapshot time. All the report data is referenced at this point of time. |
↳ report_path_prefix |
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 |
↳ shards_count |
int|string
Total shards generated for the report. |
↳ status |
Google\Rpc\Status
Status of the ReportDetail. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Labels as key value pairs |
↳ target_datetime |
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. |
↳ report_metrics |
Google\Cloud\StorageInsights\V1\ReportDetail\Metrics
Metrics of the report. |
getName
Name of resource. It will be of form projects/
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Name of resource. It will be of form projects/
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSnapshotTime
The snapshot time.
All the report data is referenced at this point of time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasSnapshotTime
clearSnapshotTime
setSnapshotTime
The snapshot time.
All the report data is referenced at this point of time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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_.
| Returns | |
|---|---|
| Type | Description |
string | |
setReportPathPrefix
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_.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getShardsCount
Total shards generated for the report.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setShardsCount
Total shards generated for the report.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
Status of the ReportDetail.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasStatus
clearStatus
setStatus
Status of the ReportDetail.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Labels as key value pairs
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Labels as key value pairs
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTargetDatetime
The date for which report is generated. The time part of target_datetime will be zero till we support multiple reports per day.
| Returns | |
|---|---|
| Type | Description |
Google\Type\DateTime|null | |
hasTargetDatetime
clearTargetDatetime
setTargetDatetime
The date for which report is generated. The time part of target_datetime will be zero till we support multiple reports per day.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\DateTime
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReportMetrics
Metrics of the report.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\StorageInsights\V1\ReportDetail\Metrics|null | |
hasReportMetrics
clearReportMetrics
setReportMetrics
Metrics of the report.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\StorageInsights\V1\ReportDetail\Metrics
|
| Returns | |
|---|---|
| Type | Description |
$this | |