Module: Crystalline::MetadataFields

Included in:
CldProvisioning::Models::Errors::APIError, CldProvisioning::Models::Errors::ErrorResponse, CldProvisioning::Models::Errors::PermissionsErrorResponse, CldProvisioning::Models::Operations::AddUserToUserGroupRequest, CldProvisioning::Models::Operations::CreateCustomPolicyRequest, CldProvisioning::Models::Operations::CreateProductEnvironmentRequest, CldProvisioning::Models::Operations::CreateRoleRequest, CldProvisioning::Models::Operations::CreateUserGroupRequest, CldProvisioning::Models::Operations::CreateUserRequest, CldProvisioning::Models::Operations::CreateUserRequestBody, CldProvisioning::Models::Operations::DeleteAccessKeyByNameRequest, CldProvisioning::Models::Operations::DeleteAccessKeyRequest, CldProvisioning::Models::Operations::DeleteCustomPolicyRequest, CldProvisioning::Models::Operations::DeleteProductEnvironmentRequest, CldProvisioning::Models::Operations::DeleteRoleRequest, CldProvisioning::Models::Operations::DeleteUserGroupRequest, CldProvisioning::Models::Operations::DeleteUserRequest, CldProvisioning::Models::Operations::GenerateAccessKeyRequest, CldProvisioning::Models::Operations::GetAccessKeysRequest, CldProvisioning::Models::Operations::GetBillingUsageRequest, CldProvisioning::Models::Operations::GetCustomPoliciesRequest, CldProvisioning::Models::Operations::GetCustomPolicyRequest, CldProvisioning::Models::Operations::GetEffectivePoliciesRequest, CldProvisioning::Models::Operations::GetGroupsForUserRequest, CldProvisioning::Models::Operations::GetPrincipalRolesRequest, CldProvisioning::Models::Operations::GetProductEnvironmentRequest, CldProvisioning::Models::Operations::GetProductEnvironmentsRequest, CldProvisioning::Models::Operations::GetRolePrincipalsRequest, CldProvisioning::Models::Operations::GetRoleRequest, CldProvisioning::Models::Operations::GetRolesRequest, CldProvisioning::Models::Operations::GetSubAccountsForUserRequest, CldProvisioning::Models::Operations::GetSystemPoliciesRequest, CldProvisioning::Models::Operations::GetUserGroupRequest, CldProvisioning::Models::Operations::GetUserGroupsRequest, CldProvisioning::Models::Operations::GetUserRequest, CldProvisioning::Models::Operations::GetUsersInUserGroupRequest, CldProvisioning::Models::Operations::GetUsersRequest, CldProvisioning::Models::Operations::InspectMultipleRequest, CldProvisioning::Models::Operations::InspectRequest, CldProvisioning::Models::Operations::RemoveUserFromUserGroupRequest, CldProvisioning::Models::Operations::UpdateAccessKeyRequest, CldProvisioning::Models::Operations::UpdateCustomPolicyRequest, CldProvisioning::Models::Operations::UpdatePrincipalRolesRequest, CldProvisioning::Models::Operations::UpdateProductEnvironmentRequest, CldProvisioning::Models::Operations::UpdateRolePrincipalsRequest, CldProvisioning::Models::Operations::UpdateRoleRequest, CldProvisioning::Models::Operations::UpdateUserGroupRequest, CldProvisioning::Models::Operations::UpdateUserRequest, CldProvisioning::Models::Shared::AccessKey, CldProvisioning::Models::Shared::AccessKeyRequest, CldProvisioning::Models::Shared::AccessKeyUpdateRequest, CldProvisioning::Models::Shared::AccessKeysResponse, CldProvisioning::Models::Shared::ApiAccessKey, CldProvisioning::Models::Shared::BillingUsageResponse, CldProvisioning::Models::Shared::BillingUsageResponseBreakdown, CldProvisioning::Models::Shared::Breakdown, CldProvisioning::Models::Shared::CedarError, CldProvisioning::Models::Shared::CedarSchemaResponse, CldProvisioning::Models::Shared::CloudAssetTypeBreakdown, CldProvisioning::Models::Shared::CreateRole, CldProvisioning::Models::Shared::CustomAttributes, CldProvisioning::Models::Shared::CustomPoliciesResponse, CldProvisioning::Models::Shared::CustomPolicy, CldProvisioning::Models::Shared::CustomPolicyResponse, CldProvisioning::Models::Shared::CustomPolicyResponseData, CldProvisioning::Models::Shared::Cycles, CldProvisioning::Models::Shared::Data, CldProvisioning::Models::Shared::Details, CldProvisioning::Models::Shared::EffectivePoliciesResponse, CldProvisioning::Models::Shared::EffectivePolicy, CldProvisioning::Models::Shared::EffectiveRole, CldProvisioning::Models::Shared::EmailPreferences, CldProvisioning::Models::Shared::Error, CldProvisioning::Models::Shared::InspectRequest, CldProvisioning::Models::Shared::InspectRequestPolicyParameters, CldProvisioning::Models::Shared::MetricUsage, CldProvisioning::Models::Shared::MonthlyCycles, CldProvisioning::Models::Shared::PermissionsError, CldProvisioning::Models::Shared::PolicyParameters, CldProvisioning::Models::Shared::Principal, CldProvisioning::Models::Shared::PrincipalResponseData, CldProvisioning::Models::Shared::PrincipalResponseDataPolicyParameters, CldProvisioning::Models::Shared::PrincipalRole, CldProvisioning::Models::Shared::PrincipalRolesData, CldProvisioning::Models::Shared::PrincipalRolesInspectData, CldProvisioning::Models::Shared::PrincipalRolesInspectResponse, CldProvisioning::Models::Shared::PrincipalRolesInspectResponseData, CldProvisioning::Models::Shared::PrincipalRolesResponse, CldProvisioning::Models::Shared::PrincipalsResponse, CldProvisioning::Models::Shared::ProductEnvironment, CldProvisioning::Models::Shared::ProductEnvironmentRequest, CldProvisioning::Models::Shared::ProductEnvironmentUpdateRequest, CldProvisioning::Models::Shared::ProductEnvironmentUpdateRequestCustomAttributes, CldProvisioning::Models::Shared::ProductEnvironmentsResponse, CldProvisioning::Models::Shared::Role, CldProvisioning::Models::Shared::RoleResponse, CldProvisioning::Models::Shared::RoleResponseData, CldProvisioning::Models::Shared::RoleResponseData1, CldProvisioning::Models::Shared::RoleToManage, CldProvisioning::Models::Shared::RoleToManagePolicyParameters, CldProvisioning::Models::Shared::RolesResponse, CldProvisioning::Models::Shared::Security, CldProvisioning::Models::Shared::SubAccountSummary, CldProvisioning::Models::Shared::SuccessResponse, CldProvisioning::Models::Shared::SystemPoliciesResponse, CldProvisioning::Models::Shared::SystemPolicyResponseData, CldProvisioning::Models::Shared::SystemRolesAndPoliciesCatalogResponse, CldProvisioning::Models::Shared::UpdateCustomPolicy, CldProvisioning::Models::Shared::UpdatePrincipalRolesRequest, CldProvisioning::Models::Shared::UpdateRolePrincipal, CldProvisioning::Models::Shared::UpdateRolePrincipalPolicyParameters, CldProvisioning::Models::Shared::UpdateRolePrincipalsRequest, CldProvisioning::Models::Shared::User, CldProvisioning::Models::Shared::UserGroup, CldProvisioning::Models::Shared::UserGroupRequest, CldProvisioning::Models::Shared::UserGroupSummary, CldProvisioning::Models::Shared::UserGroupUser, CldProvisioning::Models::Shared::UserGroupUsersResponse, CldProvisioning::Models::Shared::UserGroupsListResponse, CldProvisioning::Models::Shared::UserGroupsResponse, CldProvisioning::Models::Shared::UserRequest, CldProvisioning::Models::Shared::UserSubAccountsResponse, CldProvisioning::Models::Shared::UsersResponse, CldProvisioning::Models::Shared::ValidateCedarPolicyRequest, CldProvisioning::Models::Shared::ValidateCedarPolicyResponse
Defined in:
lib/crystalline/metadata_fields.rb

Defined Under Namespace

Modules: ClassMethods Classes: Field

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



203
204
205
 
# File 'lib/crystalline/metadata_fields.rb', line 203

def self.included(base)
  base.extend(ClassMethods)
end

Instance Method Details

#field(field_name) ⇒ Object 



211
212
213
214
215
 
# File 'lib/crystalline/metadata_fields.rb', line 211

def field(field_name)
  fields.each do |f|
    return f if f.name == field_name
  end
end

#fields ⇒ Object 



207
208
209
 
# File 'lib/crystalline/metadata_fields.rb', line 207

def fields
  self.class.fields
end

#initialize ⇒ Object 



197
198
199
200
201
 
# File 'lib/crystalline/metadata_fields.rb', line 197

def initialize
  instance = allocate
  fields.each { |mod| instance.singleton_class.include(mod) }
  instance.send(:initialize)
end

#marshal_single(field) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/crystalline/metadata_fields.rb', line 217

def marshal_single(field)
  if field.class.include? ::Crystalline::MetadataFields
    field.to_dict
  else
    if ::Crystalline.needs_string_conversion field
      ::Crystalline.json_encode field
    else
      field
    end
  end
end

#to_dict ⇒ Object 



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/crystalline/metadata_fields.rb', line 229

def to_dict
  result = {}
  fields.sort_by(&:name).each do |field|
    format_json_meta = field.metadata[:format_json]
    required = !format_json_meta.nil? && format_json_meta.include?(:required)
    is_additional_props = !format_json_meta.nil? && format_json_meta.fetch(:additional_properties, false)

    if !format_json_meta.nil? && format_json_meta.include?(:letter_case)
      key = format_json_meta[:letter_case].call(field.name)
    else
      key = field.name
    end

    f = send(field.name)
    next if f.nil? && !required
    result[key] = nil if f.nil? && required

    # Flatten additional properties into the parent object
    if is_additional_props && f.is_a?(::Hash)
      f.each { |k, v| result[k] = marshal_single(v) }
    elsif f.is_a? ::Array
      result[key] = f.map { |o| marshal_single(o) }
    elsif f.is_a? ::Hash
      result[key] = f.transform_values { |v| marshal_single(v) }
    else
      result[key] = marshal_single(f)
    end
  end
  result
end

#to_json(*args) ⇒ Object 



260
261
262
 
# File 'lib/crystalline/metadata_fields.rb', line 260

def to_json(*args)
  JSON.generate(to_dict, *args)
end