class OCI::Identity::Models::OAuth2ClientCredentialSummary
User can define Oauth clients in IAM, then use it to generate a token to grant access to app resources.
Constants
- LIFECYCLE_STATE_ENUM
Attributes
The OCID of the compartment containing the Oauth credential. @return [String]
The description of the Oauth credential. @return [String]
Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires.
Example: `2016-08-25T21:10:29.600Z`
@return [DateTime]
The OCID of the Oauth credential. @return [String]
The credential's current state. After creating a Oauth credential, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it.
@return [String]
The name of the Oauth credential. @return [String]
Allowed scopes for the given oauth credential. @return [Array<OCI::Identity::Models::FullyQualifiedScope>]
Date and time the `OAuth2ClientCredential` object was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
@return [DateTime]
The OCID of the user the Oauth credential belongs to. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/identity/models/o_auth2_client_credential_summary.rb, line 67 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'scopes': :'scopes', 'user_id': :'userId', 'expires_on': :'expiresOn', 'id': :'id', 'compartment_id': :'compartmentId', 'name': :'name', 'description': :'description', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Array<OCI::Identity::Models::FullyQualifiedScope>] :scopes The value to assign to the {#scopes} property @option attributes [String] :user_id The value to assign to the {#user_id} property @option attributes [DateTime] :expires_on The value to assign to the {#expires_on} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property
# File lib/oci/identity/models/o_auth2_client_credential_summary.rb, line 115 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.scopes = attributes[:'scopes'] if attributes[:'scopes'] self.user_id = attributes[:'userId'] if attributes[:'userId'] raise 'You cannot provide both :userId and :user_id' if attributes.key?(:'userId') && attributes.key?(:'user_id') self.user_id = attributes[:'user_id'] if attributes[:'user_id'] self.expires_on = attributes[:'expiresOn'] if attributes[:'expiresOn'] raise 'You cannot provide both :expiresOn and :expires_on' if attributes.key?(:'expiresOn') && attributes.key?(:'expires_on') self.expires_on = attributes[:'expires_on'] if attributes[:'expires_on'] self.id = attributes[:'id'] if attributes[:'id'] 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.name = attributes[:'name'] if attributes[:'name'] self.description = attributes[:'description'] if attributes[:'description'] 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.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'] end
Attribute type mapping.
# File lib/oci/identity/models/o_auth2_client_credential_summary.rb, line 84 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'scopes': :'Array<OCI::Identity::Models::FullyQualifiedScope>', 'user_id': :'String', 'expires_on': :'DateTime', 'id': :'String', 'compartment_id': :'String', 'name': :'String', 'description': :'String', 'lifecycle_state': :'String', 'time_created': :'DateTime' # 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/identity/models/o_auth2_client_credential_summary.rb, line 180 def ==(other) return true if equal?(other) self.class == other.class && scopes == other.scopes && user_id == other.user_id && expires_on == other.expires_on && id == other.id && compartment_id == other.compartment_id && name == other.name && description == other.description && lifecycle_state == other.lifecycle_state && time_created == other.time_created 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/identity/models/o_auth2_client_credential_summary.rb, line 218 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/identity/models/o_auth2_client_credential_summary.rb, line 198 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/identity/models/o_auth2_client_credential_summary.rb, line 207 def hash [scopes, user_id, expires_on, id, compartment_id, name, description, lifecycle_state, time_created].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/identity/models/o_auth2_client_credential_summary.rb, line 164 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/identity/models/o_auth2_client_credential_summary.rb, line 251 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/identity/models/o_auth2_client_credential_summary.rb, line 245 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/identity/models/o_auth2_client_credential_summary.rb, line 268 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