Class: Hubspot::Files::Files::ImportFromUrlInput
- Inherits:
-
Object
- Object
- Hubspot::Files::Files::ImportFromUrlInput
- Defined in:
- lib/hubspot/codegen/files/files/models/import_from_url_input.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#access ⇒ Object
PUBLIC_INDEXABLE: File is publicly accessible by anyone who has the URL.
-
#duplicate_validation_scope ⇒ Object
ENTIRE_PORTAL: Look for a duplicate file in the entire account.
-
#duplicate_validation_strategy ⇒ Object
NONE: Do not run any duplicate validation.
-
#folder_id ⇒ Object
One of folderId or folderPath is required.
-
#folder_path ⇒ Object
One of folderPath or folderId is required.
-
#name ⇒ Object
Name to give the resulting file in the file manager.
-
#overwrite ⇒ Object
If true, it will overwrite existing files if a file with the same name exists in the given folder.
-
#ttl ⇒ Object
Time to live.
-
#url ⇒ Object
URL to download the new file from.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ImportFromUrlInput
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ ImportFromUrlInput
Initializes the object
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 112 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Files::Files::ImportFromUrlInput` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Files::Files::ImportFromUrlInput`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'access') self.access = attributes[:'access'] end if attributes.key?(:'ttl') self.ttl = attributes[:'ttl'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'url') self.url = attributes[:'url'] end if attributes.key?(:'folder_id') self.folder_id = attributes[:'folder_id'] end if attributes.key?(:'folder_path') self.folder_path = attributes[:'folder_path'] end if attributes.key?(:'duplicate_validation_strategy') self.duplicate_validation_strategy = attributes[:'duplicate_validation_strategy'] end if attributes.key?(:'duplicate_validation_scope') self.duplicate_validation_scope = attributes[:'duplicate_validation_scope'] end if attributes.key?(:'overwrite') self.overwrite = attributes[:'overwrite'] end end |
Instance Attribute Details
#access ⇒ Object
PUBLIC_INDEXABLE: File is publicly accessible by anyone who has the URL. Search engines can index the file. PUBLIC_NOT_INDEXABLE: File is publicly accessible by anyone who has the URL. Search engines *can’t* index the file. PRIVATE: File is NOT publicly accessible. Requires a signed URL to see content. Search engines *can’t* index the file.
21 22 23 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 21 def access @access end |
#duplicate_validation_scope ⇒ Object
ENTIRE_PORTAL: Look for a duplicate file in the entire account. EXACT_FOLDER: Look for a duplicate file in the provided folder.
42 43 44 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 42 def duplicate_validation_scope @duplicate_validation_scope end |
#duplicate_validation_strategy ⇒ Object
NONE: Do not run any duplicate validation. REJECT: Reject the upload if a duplicate is found. RETURN_EXISTING: If a duplicate file is found, do not upload a new file and return the found duplicate instead.
39 40 41 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 39 def duplicate_validation_strategy @duplicate_validation_strategy end |
#folder_id ⇒ Object
One of folderId or folderPath is required. Destination folder ID for the uploaded file.
33 34 35 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 33 def folder_id @folder_id end |
#folder_path ⇒ Object
One of folderPath or folderId is required. Destination folder path for the uploaded file. If the folder path does not exist, there will be an attempt to create the folder path.
36 37 38 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 36 def folder_path @folder_path end |
#name ⇒ Object
Name to give the resulting file in the file manager.
27 28 29 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 27 def name @name end |
#overwrite ⇒ Object
If true, it will overwrite existing files if a file with the same name exists in the given folder.
45 46 47 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 45 def overwrite @overwrite end |
#ttl ⇒ Object
Time to live. If specified the file will be deleted after the given time frame.
24 25 26 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 24 def ttl @ttl end |
#url ⇒ Object
URL to download the new file from.
30 31 32 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 30 def url @url end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
85 86 87 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 85 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 70 def self.attribute_map { :'access' => :'access', :'ttl' => :'ttl', :'name' => :'name', :'url' => :'url', :'folder_id' => :'folderId', :'folder_path' => :'folderPath', :'duplicate_validation_strategy' => :'duplicateValidationStrategy', :'duplicate_validation_scope' => :'duplicateValidationScope', :'overwrite' => :'overwrite' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
267 268 269 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 267 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
105 106 107 108 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 105 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 90 def self.openapi_types { :'access' => :'String', :'ttl' => :'String', :'name' => :'String', :'url' => :'String', :'folder_id' => :'String', :'folder_path' => :'String', :'duplicate_validation_strategy' => :'String', :'duplicate_validation_scope' => :'String', :'overwrite' => :'Boolean' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 238 def ==(o) return true if self.equal?(o) self.class == o.class && access == o.access && ttl == o.ttl && name == o.name && url == o.url && folder_id == o.folder_id && folder_path == o.folder_path && duplicate_validation_strategy == o.duplicate_validation_strategy && duplicate_validation_scope == o.duplicate_validation_scope && overwrite == o.overwrite end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 298 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = Hubspot::Files::Files.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 369 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 274 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end |
#eql?(o) ⇒ Boolean
254 255 256 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 254 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
260 261 262 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 260 def hash [access, ttl, name, url, folder_id, folder_path, duplicate_validation_strategy, duplicate_validation_scope, overwrite].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 164 def list_invalid_properties invalid_properties = Array.new if @access.nil? invalid_properties.push('invalid value for "access", access cannot be nil.') end if @url.nil? invalid_properties.push('invalid value for "url", url cannot be nil.') end if @duplicate_validation_strategy.nil? invalid_properties.push('invalid value for "duplicate_validation_strategy", duplicate_validation_strategy cannot be nil.') end if @duplicate_validation_scope.nil? invalid_properties.push('invalid value for "duplicate_validation_scope", duplicate_validation_scope cannot be nil.') end if @overwrite.nil? invalid_properties.push('invalid value for "overwrite", overwrite cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
345 346 347 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 345 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
351 352 353 354 355 356 357 358 359 360 361 362 363 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 351 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
339 340 341 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 339 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/hubspot/codegen/files/files/models/import_from_url_input.rb', line 191 def valid? return false if @access.nil? access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"]) return false unless access_validator.valid?(@access) return false if @url.nil? return false if @duplicate_validation_strategy.nil? duplicate_validation_strategy_validator = EnumAttributeValidator.new('String', ["NONE", "REJECT", "RETURN_EXISTING"]) return false unless duplicate_validation_strategy_validator.valid?(@duplicate_validation_strategy) return false if @duplicate_validation_scope.nil? duplicate_validation_scope_validator = EnumAttributeValidator.new('String', ["ENTIRE_PORTAL", "EXACT_FOLDER"]) return false unless duplicate_validation_scope_validator.valid?(@duplicate_validation_scope) return false if @overwrite.nil? true end |