lib/oci/core/virtual_network_client.rb
# Lists the public IP prefixes and their details for the specified
# public virtual circuit.
#
# @param [String] virtual_circuit_id The OCID of the virtual circuit.
# @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] :verification_state A filter to only return resources that match the given verification
#   state.
#
#   The state value is case-insensitive.
#
# @return [Response] A Response object with data of type Array<{OCI::Core::Models::VirtualCircuitPublicPrefix VirtualCircuitPublicPrefix}>
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/core/list_virtual_circuit_public_prefixes.rb.html) to see an example of how to use list_virtual_circuit_public_prefixes API.
Lists the public IP prefixes and their details for the specified
public virtual circuit.
Lists the public IP prefixes and their details for the specified public virtual circuit .
def list_virtual_circuit_public_prefixes(virtual_circuit_id, opts = {})
      logger.debug 'Calling operation VirtualNetworkClient#list_virtual_circuit_public_prefixes.' if logger
      raise "Missing the required parameter 'virtual_circuit_id' when calling list_virtual_circuit_public_prefixes." if virtual_circuit_id.nil?
      if opts[:verification_state] && !OCI::Core::Models::VirtualCircuitPublicPrefix::VERIFICATION_STATE_ENUM.include?(opts[:verification_state])
        raise 'Invalid value for "verification_state", must be one of the values in OCI::Core::Models::VirtualCircuitPublicPrefix::VERIFICATION_STATE_ENUM.'
      end
      raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id)
      path = '/virtualCircuits/{virtualCircuitId}/publicPrefixes'.sub('{virtualCircuitId}', virtual_circuit_id.to_s)
      operation_signing_strategy = :standard
      query_params = {}
      query_params[:verificationState] = opts[:verification_state] if opts[:verification_state]
      header_params = {}
      header_params[:accept] = 'application/json'
      header_params[:'content-type'] = 'application/json'
      post_body = nil
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_virtual_circuit_public_prefixes') do
        @api_client.call_api(
          :GET,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Array<OCI::Core::Models::VirtualCircuitPublicPrefix>'
        )
      end
    end
def list_virtual_circuit_public_prefixes ( virtual_circuit_id , opts = { } ) logger . debug 'Calling operation VirtualNetworkClient#list_virtual_circuit_public_prefixes.' if logger raise "Missing the required parameter 'virtual_circuit_id' when calling list_virtual_circuit_public_prefixes." if virtual_circuit_id . nil? if opts [ :verification_state ] && ! OCI :: Core :: Models :: VirtualCircuitPublicPrefix :: VERIFICATION_STATE_ENUM . include? ( opts [ :verification_state ] ) raise 'Invalid value for "verification_state", must be one of the values in OCI::Core::Models::VirtualCircuitPublicPrefix::VERIFICATION_STATE_ENUM.' end raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI :: Internal :: Util . blank_string? ( virtual_circuit_id ) path = '/virtualCircuits/{virtualCircuitId}/publicPrefixes' . sub ( '{virtualCircuitId}' , virtual_circuit_id . to_s ) operation_signing_strategy = :standard query_params = { } query_params [ :verificationState ] = opts [ :verification_state ] if opts [ :verification_state ] header_params = { } header_params [ :accept ] = 'application/json' header_params [ :' content-type ' ] = 'application/json' post_body = nil OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'VirtualNetworkClient#list_virtual_circuit_public_prefixes' ) do @api_client . call_api ( :GET , path , endpoint , header_params : header_params , query_params : query_params , operation_signing_strategy : operation_signing_strategy , body : post_body , return_type : 'Array<OCI::Core::Models::VirtualCircuitPublicPrefix>' ) end end
Lists the public IP prefixes and their details for the specified
public virtual circuit.
Lists the public IP prefixes and their details for the specified public virtual circuit .
# 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 Array<{OCI::Core::Models::VirtualCircuitPublicPrefix VirtualCircuitPublicPrefix}>
A Response object with data of type Array< { OCI :: Core :: Models :: VirtualCircuitPublicPrefix VirtualCircuitPublicPrefix } >
Response
virtual_circuit_id
<not_specific>
opts
:verification_state A filter to only return resources that match the given verification state. The state value is case-insensitive.
: verification_state A filter to only return resources that match the given verification state . The state value is case - insensitive .
<not_specific>
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_virtual_circuit_public_prefixes API.
Click [ here ] to see an example of how to use list_virtual_circuit_public_prefixes API .