lib/oci/load_balancer/load_balancer_client.rb
# Update the shape of a load balancer. The new shape can be larger or smaller compared to existing shape of the
# LB. The service will try to perform this operation in the least disruptive way to existing connections, but
# there is a possibility that they might be lost during the LB resizing process. The new shape becomes effective
# as soon as the related work request completes successfully, i.e. when reshaping to a larger shape, the LB will
# start accepting larger bandwidth and when reshaping to a smaller one, the LB will be accepting smaller
# bandwidth.
#
# @param [String] load_balancer_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer whose shape will be updated.
# @param [OCI::LoadBalancer::Models::UpdateLoadBalancerShapeDetails] update_load_balancer_shape_details The details for updating a load balancer's shape. This contains the new, desired shape.
# @param [Hash] opts the optional parameters
# @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
#   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
# @option opts [String] :opc_request_id The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
#   particular request, please provide the request ID.
#    (default to )
# @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
#   server error without risk of executing that same action again. Retry tokens expire after 24
#   hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
#   has been deleted and purged from the system, then a retry of the original creation request
#   may be rejected).
#
# @return [Response] A Response object with data of type nil
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/loadbalancer/update_load_balancer_shape.rb.html) to see an example of how to use update_load_balancer_shape API.
Update the shape of a load balancer. The new shape can be larger or smaller compared to existing shape of the
LB. The service will try to perform this operation in the least disruptive way to existing connections, but
there is a possibility that they might be lost during the LB resizing process. The new shape becomes effective
as soon as the related work request completes successfully, i.e. when reshaping to a larger shape, the LB will
start accepting larger bandwidth and when reshaping to a smaller one, the LB will be accepting smaller
bandwidth.
Update the shape of a load balancer . The new shape can be larger or smaller compared to existing shape of the LB . The service will try to perform this operation in the least disruptive way to existing connections but there is a possibility that they might be lost during the LB resizing process . The new shape becomes effective as soon as the related work request completes successfully i . e . when reshaping to a larger shape the LB will start accepting larger bandwidth and when reshaping to a smaller one the LB will be accepting smaller bandwidth .
def update_load_balancer_shape(load_balancer_id, update_load_balancer_shape_details, opts = {})
      logger.debug 'Calling operation LoadBalancerClient#update_load_balancer_shape.' if logger
      raise "Missing the required parameter 'load_balancer_id' when calling update_load_balancer_shape." if load_balancer_id.nil?
      raise "Missing the required parameter 'update_load_balancer_shape_details' when calling update_load_balancer_shape." if update_load_balancer_shape_details.nil?
      raise "Parameter value for 'load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(load_balancer_id)
      path = '/loadBalancers/{loadBalancerId}/updateShape'.sub('{loadBalancerId}', load_balancer_id.to_s)
      operation_signing_strategy = :standard
      query_params = {}
      header_params = {}
      header_params[:accept] = 'application/json'
      header_params[:'content-type'] = 'application/json'
      header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
      header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
      header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token
      post_body = @api_client.object_to_http_body(update_load_balancer_shape_details)
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#update_load_balancer_shape') do
        @api_client.call_api(
          :PUT,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body
        )
      end
    end
def update_load_balancer_shape ( load_balancer_id , update_load_balancer_shape_details , opts = { } ) logger . debug 'Calling operation LoadBalancerClient#update_load_balancer_shape.' if logger raise "Missing the required parameter 'load_balancer_id' when calling update_load_balancer_shape." if load_balancer_id . nil? raise "Missing the required parameter 'update_load_balancer_shape_details' when calling update_load_balancer_shape." if update_load_balancer_shape_details . nil? raise "Parameter value for 'load_balancer_id' must not be blank" if OCI :: Internal :: Util . blank_string? ( load_balancer_id ) path = '/loadBalancers/{loadBalancerId}/updateShape' . sub ( '{loadBalancerId}' , load_balancer_id . to_s ) operation_signing_strategy = :standard query_params = { } header_params = { } header_params [ :accept ] = 'application/json' header_params [ :' content-type ' ] = 'application/json' header_params [ :' opc-request-id ' ] = opts [ :opc_request_id ] if opts [ :opc_request_id ] header_params [ :' opc-retry-token ' ] = opts [ :opc_retry_token ] if opts [ :opc_retry_token ] header_params [ :' opc-retry-token ' ] ||= OCI :: Retry . generate_opc_retry_token post_body = @api_client . object_to_http_body ( update_load_balancer_shape_details ) OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'LoadBalancerClient#update_load_balancer_shape' ) do @api_client . call_api ( :PUT , path , endpoint , header_params : header_params , query_params : query_params , operation_signing_strategy : operation_signing_strategy , body : post_body ) end end
Update the shape of a load balancer.
Update the shape of a load balancer .
# rubocop:disable Style/NegatedIf # Query Params # Header Params # rubocop:enable Style/NegatedIf # rubocop:disable Metrics/BlockLength # rubocop:enable Metrics/BlockLength
A Response object with data of type nil
A Response object with data of type nil
Response
load_balancer_id
update_load_balancer_shape_details
opts
:opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations .
: opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again . Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use update_load_balancer_shape API.
Click [ here ] to see an example of how to use update_load_balancer_shape API .