lib/oci/nosql/nosql_client.rb
# Create a new index on the table identified by tableNameOrId.
# @param [String] table_name_or_id A table name within the compartment, or a table OCID.
# @param [OCI::Nosql::Models::CreateIndexDetails] create_index_details Specifications for the new index.
# @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_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 might be rejected.
#
# @option opts [String] :opc_request_id The client request ID for tracing.
# @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/nosql/create_index.rb.html) to see an example of how to use create_index API.
Create a new index on the table identified by tableNameOrId.
Create a new index on the table identified by tableNameOrId .
def create_index(table_name_or_id, create_index_details, opts = {})
      logger.debug 'Calling operation NosqlClient#create_index.' if logger
      raise "Missing the required parameter 'table_name_or_id' when calling create_index." if table_name_or_id.nil?
      raise "Missing the required parameter 'create_index_details' when calling create_index." if create_index_details.nil?
      raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id)
      path = '/tables/{tableNameOrId}/indexes'.sub('{tableNameOrId}', table_name_or_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
      header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
      header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token
      post_body = @api_client.object_to_http_body(create_index_details)
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NosqlClient#create_index') 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
        )
      end
    end
def create_index ( table_name_or_id , create_index_details , opts = { } ) logger . debug 'Calling operation NosqlClient#create_index.' if logger raise "Missing the required parameter 'table_name_or_id' when calling create_index." if table_name_or_id . nil? raise "Missing the required parameter 'create_index_details' when calling create_index." if create_index_details . nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI :: Internal :: Util . blank_string? ( table_name_or_id ) path = '/tables/{tableNameOrId}/indexes' . sub ( '{tableNameOrId}' , table_name_or_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-retry-token ' ] = opts [ :opc_retry_token ] if opts [ :opc_retry_token ] header_params [ :' opc-request-id ' ] = opts [ :opc_request_id ] if opts [ :opc_request_id ] header_params [ :' opc-retry-token ' ] ||= OCI :: Retry . generate_opc_retry_token post_body = @api_client . object_to_http_body ( create_index_details ) OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'NosqlClient#create_index' ) 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 ) end end
Create a new index on the table identified by tableNameOrId.
Create a new index on the table identified by tableNameOrId .
# 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
table_name_or_id
create_index_details
opts
:opc_request_id The client request ID for tracing.
: opc_request_id The client request ID for tracing .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use create_index API.
Click [ here ] to see an example of how to use create_index API .