lib/oci/analytics/analytics_client.rb
# Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.
#
# @param [String] analytics_instance_id The OCID of the AnalyticsInstance.
#
# @param [String] vanity_url_key Specify unique identifier key of a vanity url to update or delete.
#
# @param [OCI::Analytics::Models::UpdateVanityUrlDetails] update_vanity_url_details Vanity url details to update (certificate).
#
# @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] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
#   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
#   will be updated or deleted only if the etag you provide matches the resource's current etag value.
#
# @option opts [String] :opc_request_id Unique 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 nil
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/analytics/update_vanity_url.rb.html) to see an example of how to use update_vanity_url API.
Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.
Allows uploading a new certificate for a vanity url which will have to be done when the current certificate is expiring .
def update_vanity_url(analytics_instance_id, vanity_url_key, update_vanity_url_details, opts = {})
      logger.debug 'Calling operation AnalyticsClient#update_vanity_url.' if logger
      raise "Missing the required parameter 'analytics_instance_id' when calling update_vanity_url." if analytics_instance_id.nil?
      raise "Missing the required parameter 'vanity_url_key' when calling update_vanity_url." if vanity_url_key.nil?
      raise "Missing the required parameter 'update_vanity_url_details' when calling update_vanity_url." if update_vanity_url_details.nil?
      raise "Parameter value for 'analytics_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(analytics_instance_id)
      raise "Parameter value for 'vanity_url_key' must not be blank" if OCI::Internal::Util.blank_string?(vanity_url_key)
      path = '/analyticsInstances/{analyticsInstanceId}/vanityUrls/{vanityUrlKey}'.sub('{analyticsInstanceId}', analytics_instance_id.to_s).sub('{vanityUrlKey}', vanity_url_key.to_s)
      operation_signing_strategy = :standard
      query_params = {}
      header_params = {}
      header_params[:accept] = 'application/json'
      header_params[:'content-type'] = 'application/json'
      header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
      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_vanity_url_details)
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnalyticsClient#update_vanity_url') 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_vanity_url ( analytics_instance_id , vanity_url_key , update_vanity_url_details , opts = { } ) logger . debug 'Calling operation AnalyticsClient#update_vanity_url.' if logger raise "Missing the required parameter 'analytics_instance_id' when calling update_vanity_url." if analytics_instance_id . nil? raise "Missing the required parameter 'vanity_url_key' when calling update_vanity_url." if vanity_url_key . nil? raise "Missing the required parameter 'update_vanity_url_details' when calling update_vanity_url." if update_vanity_url_details . nil? raise "Parameter value for 'analytics_instance_id' must not be blank" if OCI :: Internal :: Util . blank_string? ( analytics_instance_id ) raise "Parameter value for 'vanity_url_key' must not be blank" if OCI :: Internal :: Util . blank_string? ( vanity_url_key ) path = '/analyticsInstances/{analyticsInstanceId}/vanityUrls/{vanityUrlKey}' . sub ( '{analyticsInstanceId}' , analytics_instance_id . to_s ) . sub ( '{vanityUrlKey}' , vanity_url_key . to_s ) operation_signing_strategy = :standard query_params = { } header_params = { } header_params [ :accept ] = 'application/json' header_params [ :' content-type ' ] = 'application/json' header_params [ :' if-match ' ] = opts [ :if_match ] if opts [ :if_match ] 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_vanity_url_details ) OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'AnalyticsClient#update_vanity_url' ) 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
Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.
Allows uploading a new certificate for a vanity url which will have to be done when the current certificate is expiring .
# 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
analytics_instance_id
vanity_url_key
update_vanity_url_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 update_vanity_url API.
Click [ here ] to see an example of how to use update_vanity_url API .