Class: Google::Cloud::MigrationCenter::V1::Aggregation

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

Overview

Message describing an aggregation. The message includes the aggregation type, parameters, and the field on which to perform the aggregation.

Defined Under Namespace

Classes: Count, Frequency, Histogram, Sum

Instance Attribute Summary collapse

Instance Attribute Details

#count ⇒ ::Google::Cloud::MigrationCenter::V1::Aggregation::Count

Returns Count the number of matching objects.

Returns:



3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
 
# File 'proto_docs/google/cloud/migrationcenter/v1/migrationcenter.rb', line 3012

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

  # Object count.
  class Count
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sum of field values.
  class Sum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Histogram of bucketed assets counts by field value.
  # @!attribute [rw] lower_bounds
  #   @return [::Array<::Float>]
  #     Lower bounds of buckets.
  #     The response will contain `n+1` buckets for `n` bounds.
  #     The first bucket will count all assets for which the field value is
  #     smaller than the first bound.
  #     Subsequent buckets will count assets for which the field value is
  #     greater or equal to a lower bound and smaller than the next one.
  #     The last bucket will count assets for which the field value is greater or
  #     equal to the final lower bound.
  #     You can define up to 20 lower bounds.
  class Histogram
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Frequency distribution of all field values.
  class Frequency
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#field ⇒ ::String

Returns The name of the field on which to aggregate.

Returns:

  • (::String) —

    The name of the field on which to aggregate.



3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
 
# File 'proto_docs/google/cloud/migrationcenter/v1/migrationcenter.rb', line 3012

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

  # Object count.
  class Count
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sum of field values.
  class Sum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Histogram of bucketed assets counts by field value.
  # @!attribute [rw] lower_bounds
  #   @return [::Array<::Float>]
  #     Lower bounds of buckets.
  #     The response will contain `n+1` buckets for `n` bounds.
  #     The first bucket will count all assets for which the field value is
  #     smaller than the first bound.
  #     Subsequent buckets will count assets for which the field value is
  #     greater or equal to a lower bound and smaller than the next one.
  #     The last bucket will count assets for which the field value is greater or
  #     equal to the final lower bound.
  #     You can define up to 20 lower bounds.
  class Histogram
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Frequency distribution of all field values.
  class Frequency
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#frequency ⇒ ::Google::Cloud::MigrationCenter::V1::Aggregation::Frequency

Returns Creates a frequency distribution of all field values.

Returns:



3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
 
# File 'proto_docs/google/cloud/migrationcenter/v1/migrationcenter.rb', line 3012

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

  # Object count.
  class Count
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sum of field values.
  class Sum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Histogram of bucketed assets counts by field value.
  # @!attribute [rw] lower_bounds
  #   @return [::Array<::Float>]
  #     Lower bounds of buckets.
  #     The response will contain `n+1` buckets for `n` bounds.
  #     The first bucket will count all assets for which the field value is
  #     smaller than the first bound.
  #     Subsequent buckets will count assets for which the field value is
  #     greater or equal to a lower bound and smaller than the next one.
  #     The last bucket will count assets for which the field value is greater or
  #     equal to the final lower bound.
  #     You can define up to 20 lower bounds.
  class Histogram
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Frequency distribution of all field values.
  class Frequency
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#histogram ⇒ ::Google::Cloud::MigrationCenter::V1::Aggregation::Histogram

Returns Creates a bucketed histogram of field values.

Returns:



3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
 
# File 'proto_docs/google/cloud/migrationcenter/v1/migrationcenter.rb', line 3012

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

  # Object count.
  class Count
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sum of field values.
  class Sum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Histogram of bucketed assets counts by field value.
  # @!attribute [rw] lower_bounds
  #   @return [::Array<::Float>]
  #     Lower bounds of buckets.
  #     The response will contain `n+1` buckets for `n` bounds.
  #     The first bucket will count all assets for which the field value is
  #     smaller than the first bound.
  #     Subsequent buckets will count assets for which the field value is
  #     greater or equal to a lower bound and smaller than the next one.
  #     The last bucket will count assets for which the field value is greater or
  #     equal to the final lower bound.
  #     You can define up to 20 lower bounds.
  class Histogram
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Frequency distribution of all field values.
  class Frequency
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#sum ⇒ ::Google::Cloud::MigrationCenter::V1::Aggregation::Sum

Returns Sum over a numeric field.

Returns:



3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
 
# File 'proto_docs/google/cloud/migrationcenter/v1/migrationcenter.rb', line 3012

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

  # Object count.
  class Count
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sum of field values.
  class Sum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Histogram of bucketed assets counts by field value.
  # @!attribute [rw] lower_bounds
  #   @return [::Array<::Float>]
  #     Lower bounds of buckets.
  #     The response will contain `n+1` buckets for `n` bounds.
  #     The first bucket will count all assets for which the field value is
  #     smaller than the first bound.
  #     Subsequent buckets will count assets for which the field value is
  #     greater or equal to a lower bound and smaller than the next one.
  #     The last bucket will count assets for which the field value is greater or
  #     equal to the final lower bound.
  #     You can define up to 20 lower bounds.
  class Histogram
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Frequency distribution of all field values.
  class Frequency
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end