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.

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

Returns:

  • (::Google::Cloud::MigrationCenter::V1::Aggregation::Count) —

    Count the number of matching objects.

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



3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
 
# File 'proto_docs/google/cloud/migrationcenter/v1/migrationcenter.rb', line 3038

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.



3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
 
# File 'proto_docs/google/cloud/migrationcenter/v1/migrationcenter.rb', line 3038

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.

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

Returns:

  • (::Google::Cloud::MigrationCenter::V1::Aggregation::Frequency) —

    Creates a frequency distribution of all field values.

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



3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
 
# File 'proto_docs/google/cloud/migrationcenter/v1/migrationcenter.rb', line 3038

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.

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

Returns:



3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
 
# File 'proto_docs/google/cloud/migrationcenter/v1/migrationcenter.rb', line 3038

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.

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

Returns:



3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
 
# File 'proto_docs/google/cloud/migrationcenter/v1/migrationcenter.rb', line 3038

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