Class: Google::Cloud::Container::V1::OperationProgress

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

Overview

Information about operation (or operation stage) progress.

Defined Under Namespace

Classes: Metric

Instance Attribute Summary collapse

Instance Attribute Details

#metrics ⇒ ::Array<::Google::Cloud::Container::V1::OperationProgress::Metric>

Returns Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}].

Returns:

  • (::Array<::Google::Cloud::Container::V1::OperationProgress::Metric>) —

    Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]



2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 2944

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

  # Progress metric is (string, int|float|string) pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Metric name, e.g., "nodes total", "percent done".
  # @!attribute [rw] int_value
  #   @return [::Integer]
  #     For metrics with integer value.
  #
  #     Note: The following fields are mutually exclusive: `int_value`, `double_value`, `string_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] double_value
  #   @return [::Float]
  #     For metrics with floating point value.
  #
  #     Note: The following fields are mutually exclusive: `double_value`, `int_value`, `string_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] string_value
  #   @return [::String]
  #     For metrics with custom values (ratios, visual progress, etc.).
  #
  #     Note: The following fields are mutually exclusive: `string_value`, `int_value`, `double_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Metric
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns A non-parameterized string describing an operation stage. Unset for single-stage operations.

Returns:

  • (::String) —

    A non-parameterized string describing an operation stage. Unset for single-stage operations.



2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 2944

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

  # Progress metric is (string, int|float|string) pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Metric name, e.g., "nodes total", "percent done".
  # @!attribute [rw] int_value
  #   @return [::Integer]
  #     For metrics with integer value.
  #
  #     Note: The following fields are mutually exclusive: `int_value`, `double_value`, `string_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] double_value
  #   @return [::Float]
  #     For metrics with floating point value.
  #
  #     Note: The following fields are mutually exclusive: `double_value`, `int_value`, `string_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] string_value
  #   @return [::String]
  #     For metrics with custom values (ratios, visual progress, etc.).
  #
  #     Note: The following fields are mutually exclusive: `string_value`, `int_value`, `double_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Metric
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#stages ⇒ ::Array<::Google::Cloud::Container::V1::OperationProgress>

Returns Substages of an operation or a stage.

Returns:



2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 2944

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

  # Progress metric is (string, int|float|string) pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Metric name, e.g., "nodes total", "percent done".
  # @!attribute [rw] int_value
  #   @return [::Integer]
  #     For metrics with integer value.
  #
  #     Note: The following fields are mutually exclusive: `int_value`, `double_value`, `string_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] double_value
  #   @return [::Float]
  #     For metrics with floating point value.
  #
  #     Note: The following fields are mutually exclusive: `double_value`, `int_value`, `string_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] string_value
  #   @return [::String]
  #     For metrics with custom values (ratios, visual progress, etc.).
  #
  #     Note: The following fields are mutually exclusive: `string_value`, `int_value`, `double_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Metric
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#status ⇒ ::Google::Cloud::Container::V1::Operation::Status

Returns Status of an operation stage. Unset for single-stage operations.

Returns:



2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 2944

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

  # Progress metric is (string, int|float|string) pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Metric name, e.g., "nodes total", "percent done".
  # @!attribute [rw] int_value
  #   @return [::Integer]
  #     For metrics with integer value.
  #
  #     Note: The following fields are mutually exclusive: `int_value`, `double_value`, `string_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] double_value
  #   @return [::Float]
  #     For metrics with floating point value.
  #
  #     Note: The following fields are mutually exclusive: `double_value`, `int_value`, `string_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] string_value
  #   @return [::String]
  #     For metrics with custom values (ratios, visual progress, etc.).
  #
  #     Note: The following fields are mutually exclusive: `string_value`, `int_value`, `double_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Metric
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end