class OCI::Core::Models::VirtualCircuitPublicPrefix
A public IP prefix and its details. With a public virtual circuit, the customer specifies the customer-owned public IP prefixes to advertise across the connection. For more information, see [FastConnect Overview](docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).
Constants
- VERIFICATION_STATE_ENUM
Attributes
[Required] Publix IP prefix (CIDR) that the customer specified. @return [String]
[Required] Oracle must verify that the customer owns the public IP prefix before traffic for that prefix can flow across the virtual circuit. Verification can take a few business days. `IN_PROGRESS` means Oracle is verifying the prefix. `COMPLETED` means verification succeeded. `FAILED` means verification failed and traffic for this prefix will not flow across the connection.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/core/models/virtual_circuit_public_prefix.rb, line 35 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'cidr_block': :'cidrBlock', 'verification_state': :'verificationState' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :cidr_block The value to assign to the {#cidr_block} property @option attributes [String] :verification_state The value to assign to the {#verification_state} property
# File lib/oci/core/models/virtual_circuit_public_prefix.rb, line 62 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.cidr_block = attributes[:'cidrBlock'] if attributes[:'cidrBlock'] raise 'You cannot provide both :cidrBlock and :cidr_block' if attributes.key?(:'cidrBlock') && attributes.key?(:'cidr_block') self.cidr_block = attributes[:'cidr_block'] if attributes[:'cidr_block'] self.verification_state = attributes[:'verificationState'] if attributes[:'verificationState'] raise 'You cannot provide both :verificationState and :verification_state' if attributes.key?(:'verificationState') && attributes.key?(:'verification_state') self.verification_state = attributes[:'verification_state'] if attributes[:'verification_state'] end
Attribute type mapping.
# File lib/oci/core/models/virtual_circuit_public_prefix.rb, line 45 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'cidr_block': :'String', 'verification_state': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/core/models/virtual_circuit_public_prefix.rb, line 101 def ==(other) return true if equal?(other) self.class == other.class && cidr_block == other.cidr_block && verification_state == other.verification_state end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/core/models/virtual_circuit_public_prefix.rb, line 132 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/core/models/virtual_circuit_public_prefix.rb, line 112 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/core/models/virtual_circuit_public_prefix.rb, line 121 def hash [cidr_block, verification_state].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/core/models/virtual_circuit_public_prefix.rb, line 165 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/core/models/virtual_circuit_public_prefix.rb, line 159 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] verification_state
Object
to be assigned
# File lib/oci/core/models/virtual_circuit_public_prefix.rb, line 85 def verification_state=(verification_state) # rubocop:disable Style/ConditionalAssignment if verification_state && !VERIFICATION_STATE_ENUM.include?(verification_state) OCI.logger.debug("Unknown value for 'verification_state' [" + verification_state + "]. Mapping to 'VERIFICATION_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @verification_state = VERIFICATION_STATE_UNKNOWN_ENUM_VALUE else @verification_state = verification_state end # rubocop:enable Style/ConditionalAssignment end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/core/models/virtual_circuit_public_prefix.rb, line 182 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end