Class: Google::Cloud::StorageInsights::V1::ReportDetail

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 ReportDetail object. ReportDetail represents metadata of generated reports for a ReportConfig. Next ID: 10

Defined Under Namespace

Classes: LabelsEntry, Metrics

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Labels as key value pairs.

Returns:

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

    Labels as key value pairs



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 191

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

  # Different metrics associated with the generated report.
  # @!attribute [rw] processed_records_count
  #   @return [::Integer]
  #     Count of Cloud Storage objects which are part of the report.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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//reportDetails/.

Returns:

  • (::String) —

    Name of resource. It will be of form projects//locations//reportConfigs//reportDetails/.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 191

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

  # Different metrics associated with the generated report.
  # @!attribute [rw] processed_records_count
  #   @return [::Integer]
  #     Count of Cloud Storage objects which are part of the report.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#report_metrics ⇒ ::Google::Cloud::StorageInsights::V1::ReportDetail::Metrics

Returns Metrics of the report.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 191

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

  # Different metrics associated with the generated report.
  # @!attribute [rw] processed_records_count
  #   @return [::Integer]
  #     Count of Cloud Storage objects which are part of the report.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#report_path_prefix ⇒ ::String

Returns 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_.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 191

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

  # Different metrics associated with the generated report.
  # @!attribute [rw] processed_records_count
  #   @return [::Integer]
  #     Count of Cloud Storage objects which are part of the report.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#shards_count ⇒ ::Integer

Returns Total shards generated for the report.

Returns:

  • (::Integer) —

    Total shards generated for the report.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 191

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

  # Different metrics associated with the generated report.
  # @!attribute [rw] processed_records_count
  #   @return [::Integer]
  #     Count of Cloud Storage objects which are part of the report.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#snapshot_time ⇒ ::Google::Protobuf::Timestamp

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

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 191

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

  # Different metrics associated with the generated report.
  # @!attribute [rw] processed_records_count
  #   @return [::Integer]
  #     Count of Cloud Storage objects which are part of the report.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#status ⇒ ::Google::Rpc::Status

Returns Status of the ReportDetail.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 191

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

  # Different metrics associated with the generated report.
  # @!attribute [rw] processed_records_count
  #   @return [::Integer]
  #     Count of Cloud Storage objects which are part of the report.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#target_datetime ⇒ ::Google::Type::DateTime

Returns 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.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'proto_docs/google/cloud/storageinsights/v1/storageinsights.rb', line 191

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

  # Different metrics associated with the generated report.
  # @!attribute [rw] processed_records_count
  #   @return [::Integer]
  #     Count of Cloud Storage objects which are part of the report.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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