Class: Google::Cloud::StorageInsights::V1::ReportConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/storageinsights/v1/storageinsights.rb

Overview

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

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. [Output only] Create time stamp.

Returns:



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 423

class ReportConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#csv_options ⇒ ::Google::Cloud::StorageInsights::V1::CSVOptions

Returns Options for CSV formatted reports.

Note: The following fields are mutually exclusive: csv_options, parquet_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::StorageInsights::V1::CSVOptions) —

    Options for CSV formatted reports.

    Note: The following fields are mutually exclusive: csv_options, parquet_options. If a field in that set is populated, all other fields in the set will automatically be cleared.



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 423

class ReportConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

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

Returns:

  • (::String) —

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



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 423

class ReportConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#frequency_options ⇒ ::Google::Cloud::StorageInsights::V1::FrequencyOptions

Returns The frequency of report generation.

Returns:



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 423

class ReportConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Labels as key value pairs.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Labels as key value pairs



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 423

class ReportConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns name of resource. It will be of form projects//locations//reportConfigs/.

Returns:

  • (::String) —

    name of resource. It will be of form projects//locations//reportConfigs/.



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 423

class ReportConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#object_metadata_report_options ⇒ ::Google::Cloud::StorageInsights::V1::ObjectMetadataReportOptions

Returns Report for exporting object metadata.

Returns:



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 423

class ReportConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parquet_options ⇒ ::Google::Cloud::StorageInsights::V1::ParquetOptions

Returns Options for Parquet formatted reports.

Note: The following fields are mutually exclusive: parquet_options, csv_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::StorageInsights::V1::ParquetOptions) —

    Options for Parquet formatted reports.

    Note: The following fields are mutually exclusive: parquet_options, csv_options. If a field in that set is populated, all other fields in the set will automatically be cleared.



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 423

class ReportConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. [Output only] Update time stamp.

Returns:



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 423

class ReportConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end