lib/oci/streaming/stream_admin_client.rb
# Starts the provisioning of a new stream pool.
# To track the progress of the provisioning, you can periodically call GetStreamPool.
# In the response, the `lifecycleState` parameter of the object tells you its current state.
#
# @param [OCI::Streaming::Models::CreateStreamPoolDetails] create_stream_pool_details The stream pool to create.
# @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.
#
# @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 (for example, 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 {OCI::Streaming::Models::StreamPool StreamPool}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/create_stream_pool.rb.html) to see an example of how to use create_stream_pool API.
Starts the provisioning of a new stream pool.
To track the progress of the provisioning, you can periodically call GetStreamPool.
In the response, the `lifecycleState` parameter of the object tells you its current state.
Starts the provisioning of a new stream pool . To track the progress of the provisioning you can periodically call GetStreamPool . In the response the ` lifecycleState ` parameter of the object tells you its current state .
def create_stream_pool(create_stream_pool_details, opts = {})
      logger.debug 'Calling operation StreamAdminClient#create_stream_pool.' if logger
      raise "Missing the required parameter 'create_stream_pool_details' when calling create_stream_pool." if create_stream_pool_details.nil?
      path = '/streampools'
      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(create_stream_pool_details)
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'StreamAdminClient#create_stream_pool') do
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'OCI::Streaming::Models::StreamPool'
        )
      end
    end
def create_stream_pool ( create_stream_pool_details , opts = { } ) logger . debug 'Calling operation StreamAdminClient#create_stream_pool.' if logger raise "Missing the required parameter 'create_stream_pool_details' when calling create_stream_pool." if create_stream_pool_details . nil? path = '/streampools' 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 ( create_stream_pool_details ) OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'StreamAdminClient#create_stream_pool' ) do @api_client . call_api ( :POST , path , endpoint , header_params : header_params , query_params : query_params , operation_signing_strategy : operation_signing_strategy , body : post_body , return_type : 'OCI::Streaming::Models::StreamPool' ) end end
Starts the provisioning of a new stream pool.
Starts the provisioning of a new stream pool .
# 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 {OCI::Streaming::Models::StreamPool StreamPool}
A Response object with data of type { OCI :: Streaming :: Models :: StreamPool StreamPool }
Response
create_stream_pool_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 (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
: 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 ( for example if a resource has been deleted and purged from the system then a retry of the original creation request may be rejected ) .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use create_stream_pool API.
Click [ here ] to see an example of how to use create_stream_pool API .