Class: Google::Apis::ServiceusageV1beta1::BatchingSettingsProto

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/serviceusage_v1beta1/classes.rb,
lib/google/apis/serviceusage_v1beta1/representations.rb,
lib/google/apis/serviceusage_v1beta1/representations.rb

Overview

BatchingSettingsProto specifies a set of batching thresholds, each of which acts as a trigger to send a batch of messages as a request. At least one threshold must be positive nonzero.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BatchingSettingsProto

Returns a new instance of BatchingSettingsProto.



908
909
910
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 908

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#delay_threshold ⇒ String

The duration after which a batch should be sent, starting from the addition of the first message to that batch. Corresponds to the JSON property delayThreshold

Returns:

  • (String) 


867
868
869
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 867

def delay_threshold
  @delay_threshold
end

#element_count_limit ⇒ Fixnum

The maximum number of elements collected in a batch that could be accepted by server. Corresponds to the JSON property elementCountLimit

Returns:

  • (Fixnum) 


873
874
875
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 873

def element_count_limit
  @element_count_limit
end

#element_count_threshold ⇒ Fixnum

The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent. Corresponds to the JSON property elementCountThreshold

Returns:

  • (Fixnum) 


879
880
881
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 879

def element_count_threshold
  @element_count_threshold
end

#flow_control_byte_limit ⇒ Fixnum

The maximum size of data allowed by flow control. Corresponds to the JSON property flowControlByteLimit

Returns:

  • (Fixnum) 


884
885
886
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 884

def flow_control_byte_limit
  @flow_control_byte_limit
end

#flow_control_element_limit ⇒ Fixnum

The maximum number of elements allowed by flow control. Corresponds to the JSON property flowControlElementLimit

Returns:

  • (Fixnum) 


889
890
891
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 889

def flow_control_element_limit
  @flow_control_element_limit
end

#flow_control_limit_exceeded_behavior ⇒ String

The behavior to take when the flow control limit is exceeded. Corresponds to the JSON property flowControlLimitExceededBehavior

Returns:

  • (String) 


894
895
896
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 894

def flow_control_limit_exceeded_behavior
  @flow_control_limit_exceeded_behavior
end

#request_byte_limit ⇒ Fixnum

The maximum size of the request that could be accepted by server. Corresponds to the JSON property requestByteLimit

Returns:

  • (Fixnum) 


899
900
901
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 899

def request_byte_limit
  @request_byte_limit
end

#request_byte_threshold ⇒ Fixnum

The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message. Corresponds to the JSON property requestByteThreshold

Returns:

  • (Fixnum) 


906
907
908
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 906

def request_byte_threshold
  @request_byte_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



913
914
915
916
917
918
919
920
921
922
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 913

def update!(**args)
  @delay_threshold = args[:delay_threshold] if args.key?(:delay_threshold)
  @element_count_limit = args[:element_count_limit] if args.key?(:element_count_limit)
  @element_count_threshold = args[:element_count_threshold] if args.key?(:element_count_threshold)
  @flow_control_byte_limit = args[:flow_control_byte_limit] if args.key?(:flow_control_byte_limit)
  @flow_control_element_limit = args[:flow_control_element_limit] if args.key?(:flow_control_element_limit)
  @flow_control_limit_exceeded_behavior = args[:flow_control_limit_exceeded_behavior] if args.key?(:flow_control_limit_exceeded_behavior)
  @request_byte_limit = args[:request_byte_limit] if args.key?(:request_byte_limit)
  @request_byte_threshold = args[:request_byte_threshold] if args.key?(:request_byte_threshold)
end