Class: Google::Apis::ServiceusageV1::BatchingSettingsProto

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/serviceusage_v1/classes.rb,
lib/google/apis/serviceusage_v1/representations.rb,
lib/google/apis/serviceusage_v1/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.



927
928
929
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 927

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) 


886
887
888
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 886

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) 


892
893
894
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 892

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) 


898
899
900
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 898

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) 


903
904
905
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 903

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) 


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

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) 


913
914
915
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 913

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) 


918
919
920
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 918

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) 


925
926
927
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 925

def request_byte_threshold
  @request_byte_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



932
933
934
935
936
937
938
939
940
941
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 932

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