class OCI::Bastion::Models::Bastion
A bastion resource. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet. A bastion resides in a public subnet and establishes the network infrastructure needed to connect a user to a target resource in a private subnet.
Constants
- LIFECYCLE_STATE_ENUM
Attributes
[Required] The type of bastion. @return [String]
A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion. @return [Array<String>]
[Required] The unique identifier (OCID) of the compartment where the bastion is located. @return [String]
[Required] The unique identifier (OCID) of the bastion, which can't be changed after creation. @return [String]
A message describing the current state in more detail. @return [String]
[Required] The current state of the bastion. @return [String]
[Required] The maximum amount of time that any session on the bastion can remain active. @return [Integer]
The maximum number of active sessions allowed on the bastion. @return [Integer]
[Required] The name of the bastion, which can't be changed after creation. @return [String]
The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to `standard` bastions.
@return [String]
The private IP address of the created private endpoint. @return [String]
A list of IP addresses of the hosts that the bastion has access to. Not applicable to `standard` bastions.
@return [Array<String>]
[Required] The unique identifier (OCID) of the subnet that the bastion connects to. @return [String]
[Required] The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to. @return [String]
[Required] The time the bastion was created. Format is defined by [RFC3339](tools.ietf.org/html/rfc3339). Example: `2020-01-25T21:10:29.600Z`
@return [DateTime]
The time the bastion was updated. Format is defined by [RFC3339](tools.ietf.org/html/rfc3339). Example: `2020-01-25T21:10:29.600Z`
@return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/bastion/models/bastion.rb, line 110 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'bastion_type': :'bastionType', 'id': :'id', 'name': :'name', 'compartment_id': :'compartmentId', 'target_vcn_id': :'targetVcnId', 'target_subnet_id': :'targetSubnetId', 'phone_book_entry': :'phoneBookEntry', 'client_cidr_block_allow_list': :'clientCidrBlockAllowList', 'static_jump_host_ip_addresses': :'staticJumpHostIpAddresses', 'private_endpoint_ip_address': :'privateEndpointIpAddress', 'max_session_ttl_in_seconds': :'maxSessionTtlInSeconds', 'max_sessions_allowed': :'maxSessionsAllowed', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :bastion_type The value to assign to the {#bastion_type} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :target_vcn_id The value to assign to the {#target_vcn_id} property @option attributes [String] :target_subnet_id The value to assign to the {#target_subnet_id} property @option attributes [String] :phone_book_entry The value to assign to the {#phone_book_entry} property @option attributes [Array<String>] :client_cidr_block_allow_list The value to assign to the {#client_cidr_block_allow_list} property @option attributes [Array<String>] :static_jump_host_ip_addresses The value to assign to the {#static_jump_host_ip_addresses} property @option attributes [String] :private_endpoint_ip_address The value to assign to the {#private_endpoint_ip_address} property @option attributes [Integer] :max_session_ttl_in_seconds The value to assign to the {#max_session_ttl_in_seconds} property @option attributes [Integer] :max_sessions_allowed The value to assign to the {#max_sessions_allowed} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_updated The value to assign to the {#time_updated} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [String] :lifecycle_details The value to assign to the {#lifecycle_details} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [Hash<String, Hash<String, Object>>] :system_tags The value to assign to the {#system_tags} property
# File lib/oci/bastion/models/bastion.rb, line 188 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.bastion_type = attributes[:'bastionType'] if attributes[:'bastionType'] raise 'You cannot provide both :bastionType and :bastion_type' if attributes.key?(:'bastionType') && attributes.key?(:'bastion_type') self.bastion_type = attributes[:'bastion_type'] if attributes[:'bastion_type'] self.id = attributes[:'id'] if attributes[:'id'] self.name = attributes[:'name'] if attributes[:'name'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.target_vcn_id = attributes[:'targetVcnId'] if attributes[:'targetVcnId'] raise 'You cannot provide both :targetVcnId and :target_vcn_id' if attributes.key?(:'targetVcnId') && attributes.key?(:'target_vcn_id') self.target_vcn_id = attributes[:'target_vcn_id'] if attributes[:'target_vcn_id'] self.target_subnet_id = attributes[:'targetSubnetId'] if attributes[:'targetSubnetId'] raise 'You cannot provide both :targetSubnetId and :target_subnet_id' if attributes.key?(:'targetSubnetId') && attributes.key?(:'target_subnet_id') self.target_subnet_id = attributes[:'target_subnet_id'] if attributes[:'target_subnet_id'] self.phone_book_entry = attributes[:'phoneBookEntry'] if attributes[:'phoneBookEntry'] raise 'You cannot provide both :phoneBookEntry and :phone_book_entry' if attributes.key?(:'phoneBookEntry') && attributes.key?(:'phone_book_entry') self.phone_book_entry = attributes[:'phone_book_entry'] if attributes[:'phone_book_entry'] self.client_cidr_block_allow_list = attributes[:'clientCidrBlockAllowList'] if attributes[:'clientCidrBlockAllowList'] raise 'You cannot provide both :clientCidrBlockAllowList and :client_cidr_block_allow_list' if attributes.key?(:'clientCidrBlockAllowList') && attributes.key?(:'client_cidr_block_allow_list') self.client_cidr_block_allow_list = attributes[:'client_cidr_block_allow_list'] if attributes[:'client_cidr_block_allow_list'] self.static_jump_host_ip_addresses = attributes[:'staticJumpHostIpAddresses'] if attributes[:'staticJumpHostIpAddresses'] raise 'You cannot provide both :staticJumpHostIpAddresses and :static_jump_host_ip_addresses' if attributes.key?(:'staticJumpHostIpAddresses') && attributes.key?(:'static_jump_host_ip_addresses') self.static_jump_host_ip_addresses = attributes[:'static_jump_host_ip_addresses'] if attributes[:'static_jump_host_ip_addresses'] self.private_endpoint_ip_address = attributes[:'privateEndpointIpAddress'] if attributes[:'privateEndpointIpAddress'] raise 'You cannot provide both :privateEndpointIpAddress and :private_endpoint_ip_address' if attributes.key?(:'privateEndpointIpAddress') && attributes.key?(:'private_endpoint_ip_address') self.private_endpoint_ip_address = attributes[:'private_endpoint_ip_address'] if attributes[:'private_endpoint_ip_address'] self.max_session_ttl_in_seconds = attributes[:'maxSessionTtlInSeconds'] if attributes[:'maxSessionTtlInSeconds'] raise 'You cannot provide both :maxSessionTtlInSeconds and :max_session_ttl_in_seconds' if attributes.key?(:'maxSessionTtlInSeconds') && attributes.key?(:'max_session_ttl_in_seconds') self.max_session_ttl_in_seconds = attributes[:'max_session_ttl_in_seconds'] if attributes[:'max_session_ttl_in_seconds'] self.max_sessions_allowed = attributes[:'maxSessionsAllowed'] if attributes[:'maxSessionsAllowed'] raise 'You cannot provide both :maxSessionsAllowed and :max_sessions_allowed' if attributes.key?(:'maxSessionsAllowed') && attributes.key?(:'max_sessions_allowed') self.max_sessions_allowed = attributes[:'max_sessions_allowed'] if attributes[:'max_sessions_allowed'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated'] raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated') self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails'] raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details') self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details'] self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags'] end
Attribute type mapping.
# File lib/oci/bastion/models/bastion.rb, line 137 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'bastion_type': :'String', 'id': :'String', 'name': :'String', 'compartment_id': :'String', 'target_vcn_id': :'String', 'target_subnet_id': :'String', 'phone_book_entry': :'String', 'client_cidr_block_allow_list': :'Array<String>', 'static_jump_host_ip_addresses': :'Array<String>', 'private_endpoint_ip_address': :'String', 'max_session_ttl_in_seconds': :'Integer', 'max_sessions_allowed': :'Integer', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>' # 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/bastion/models/bastion.rb, line 321 def ==(other) return true if equal?(other) self.class == other.class && bastion_type == other.bastion_type && id == other.id && name == other.name && compartment_id == other.compartment_id && target_vcn_id == other.target_vcn_id && target_subnet_id == other.target_subnet_id && phone_book_entry == other.phone_book_entry && client_cidr_block_allow_list == other.client_cidr_block_allow_list && static_jump_host_ip_addresses == other.static_jump_host_ip_addresses && private_endpoint_ip_address == other.private_endpoint_ip_address && max_session_ttl_in_seconds == other.max_session_ttl_in_seconds && max_sessions_allowed == other.max_sessions_allowed && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags && system_tags == other.system_tags 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/bastion/models/bastion.rb, line 369 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/bastion/models/bastion.rb, line 349 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/bastion/models/bastion.rb, line 358 def hash [bastion_type, id, name, compartment_id, target_vcn_id, target_subnet_id, phone_book_entry, client_cidr_block_allow_list, static_jump_host_ip_addresses, private_endpoint_ip_address, max_session_ttl_in_seconds, max_sessions_allowed, time_created, time_updated, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/bastion/models/bastion.rb, line 305 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/bastion/models/bastion.rb, line 402 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/bastion/models/bastion.rb, line 396 def to_s to_hash.to_s 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/bastion/models/bastion.rb, line 419 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