Google Cloud Storage Insights V1 Client - Class ReportConfig (0.2.3)

Reference documentation and code samples for the Google Cloud Storage Insights V1 Client class ReportConfig.

Message describing ReportConfig object. ReportConfig is the configuration to generate reports.

See https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest for more details on how to set various fields. Next ID: 12

Generated from protobuf message google.cloud.storageinsights.v1.ReportConfig

Namespace

Google \ Cloud \ StorageInsights \ V1

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/
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. [Output only] Create time stamp
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. [Output only] Update time stamp
`↳ frequency_options`	`Google\Cloud\StorageInsights\V1\FrequencyOptions` The frequency of report generation.
`↳ csv_options`	`Google\Cloud\StorageInsights\V1\CSVOptions` Options for CSV formatted reports.
`↳ parquet_options`	`Google\Cloud\StorageInsights\V1\ParquetOptions` Options for Parquet formatted reports.
`↳ object_metadata_report_options`	`Google\Cloud\StorageInsights\V1\ObjectMetadataReportOptions` Report for exporting object metadata.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Labels as key value pairs
`↳ display_name`	`string` User provided display name which can be empty and limited to 256 characters that is editable.

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`

getCreateTime

Output only. [Output only] Create time stamp

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. [Output only] Create time stamp

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. [Output only] Update time stamp

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. [Output only] Update time stamp

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getFrequencyOptions

The frequency of report generation.

Returns
Type	Description
`Google\Cloud\StorageInsights\V1\FrequencyOptions\|null`

hasFrequencyOptions

clearFrequencyOptions

setFrequencyOptions

The frequency of report generation.

Parameter
Name	Description
`var`	`Google\Cloud\StorageInsights\V1\FrequencyOptions`

Returns
Type	Description
`$this`

getCsvOptions

Options for CSV formatted reports.

Returns
Type	Description
`Google\Cloud\StorageInsights\V1\CSVOptions\|null`

hasCsvOptions

setCsvOptions

Options for CSV formatted reports.

Parameter
Name	Description
`var`	`Google\Cloud\StorageInsights\V1\CSVOptions`

Returns
Type	Description
`$this`

getParquetOptions

Options for Parquet formatted reports.

Returns
Type	Description
`Google\Cloud\StorageInsights\V1\ParquetOptions\|null`

hasParquetOptions

setParquetOptions

Options for Parquet formatted reports.

Parameter
Name	Description
`var`	`Google\Cloud\StorageInsights\V1\ParquetOptions`

Returns
Type	Description
`$this`

getObjectMetadataReportOptions

Report for exporting object metadata.

Returns
Type	Description
`Google\Cloud\StorageInsights\V1\ObjectMetadataReportOptions\|null`

hasObjectMetadataReportOptions

setObjectMetadataReportOptions

Report for exporting object metadata.

Parameter
Name	Description
`var`	`Google\Cloud\StorageInsights\V1\ObjectMetadataReportOptions`

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`

getDisplayName

User provided display name which can be empty and limited to 256 characters that is editable.

Returns
Type	Description
`string`

setDisplayName

User provided display name which can be empty and limited to 256 characters that is editable.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getReportFormat

Returns
Type	Description
`string`

getReportKind

Returns
Type	Description
`string`