Class: Azure::ARM::CDN::Models::EndpointProperties

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/azure_mgmt_cdn/models/endpoint_properties.rb

Overview

Model object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#content_types_to_compress ⇒ Array<String>

will be applied. The value for the elements should be Internet media type.

Returns:

  • (Array<String>) —

    List of content types on which compression



29
30
31
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 29

def content_types_to_compress
  @content_types_to_compress
end

#host_name ⇒ String

Returns The host name of the endpoint endpointName.DNSZone.

Returns:

  • (String) —

    The host name of the endpoint endpointName.DNSZone



16
17
18
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 16

def host_name
  @host_name
end

#is_compression_enabled ⇒ Boolean

Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller than 1 MB.

Returns:

  • (Boolean) —

    Indicates whether the compression is enabled.



35
36
37
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 35

def is_compression_enabled
  @is_compression_enabled
end

#is_http_allowed ⇒ Boolean

endpoint. Default value is true. At least one protocol (http or https) must be allowed.

Returns:

  • (Boolean) —

    Indicates whether http traffic is allowed on the



40
41
42
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 40

def is_http_allowed
  @is_http_allowed
end

#is_https_allowed ⇒ Boolean

endpoint. Default value is true. At least one protocol (http or https) must be allowed.

Returns:

  • (Boolean) —

    Indicates whether https traffic is allowed on the



45
46
47
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 45

def is_https_allowed
  @is_https_allowed
end

#origin_host_header ⇒ String

content requests to origins. The default value would be the host name of the origin.

Returns:

  • (String) —

    The host header CDN provider will send along with



21
22
23
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 21

def origin_host_header
  @origin_host_header
end

#origin_path ⇒ String

Returns The path used for origin requests.

Returns:

  • (String) —

    The path used for origin requests



24
25
26
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 24

def origin_path
  @origin_path
end

#origins ⇒ Array<DeepCreatedOrigin>

endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options.

Returns:



55
56
57
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 55

def origins
  @origins
end

#provisioning_state ⇒ ProvisioningState

Possible values include: ‘Creating’, ‘Succeeded’, ‘Failed’

Returns:



64
65
66
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 64

def provisioning_state
  @provisioning_state
end

#query_string_caching_behavior ⇒ QueryStringCachingBehavior

behavior. Possible values include: ‘IgnoreQueryString’, ‘BypassCaching’, ‘UseQueryString’, ‘NotSet’

Returns:



50
51
52
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 50

def query_string_caching_behavior
  @query_string_caching_behavior
end

#resource_state ⇒ EndpointResourceState

Possible values include: ‘Creating’, ‘Deleting’, ‘Running’, ‘Starting’, ‘Stopped’, ‘Stopping’

Returns:



60
61
62
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 60

def resource_state
  @resource_state
end

Class Method Details

.deserialize_object(object) ⇒ EndpointProperties

Deserializes given Ruby Hash into Model object.

Parameters:

  • object (Hash) —

    Ruby Hash object to deserialize.

Returns:



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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 134

def self.deserialize_object(object)
  return if object.nil?
  output_object = EndpointProperties.new

  deserialized_property = object['hostName']
  output_object.host_name = deserialized_property

  deserialized_property = object['originHostHeader']
  output_object.origin_host_header = deserialized_property

  deserialized_property = object['originPath']
  output_object.origin_path = deserialized_property

  deserialized_property = object['contentTypesToCompress']
  output_object.content_types_to_compress = deserialized_property

  deserialized_property = object['isCompressionEnabled']
  output_object.is_compression_enabled = deserialized_property

  deserialized_property = object['isHttpAllowed']
  output_object.is_http_allowed = deserialized_property

  deserialized_property = object['isHttpsAllowed']
  output_object.is_https_allowed = deserialized_property

  deserialized_property = object['queryStringCachingBehavior']
  if (!deserialized_property.nil? && !deserialized_property.empty?)
    enum_is_valid = QueryStringCachingBehavior.constants.any? { |e| QueryStringCachingBehavior.const_get(e).to_s.downcase == deserialized_property.downcase }
    warn 'Enum QueryStringCachingBehavior does not contain ' + deserialized_property.downcase + ', but was received from the server.' unless enum_is_valid
  end
  output_object.query_string_caching_behavior = deserialized_property

  deserialized_property = object['origins']
  unless deserialized_property.nil?
    deserialized_array = []
    deserialized_property.each do |element3|
      unless element3.nil?
        element3 = DeepCreatedOrigin.deserialize_object(element3)
      end
      deserialized_array.push(element3)
    end
    deserialized_property = deserialized_array
  end
  output_object.origins = deserialized_property

  deserialized_property = object['resourceState']
  if (!deserialized_property.nil? && !deserialized_property.empty?)
    enum_is_valid = EndpointResourceState.constants.any? { |e| EndpointResourceState.const_get(e).to_s.downcase == deserialized_property.downcase }
    warn 'Enum EndpointResourceState does not contain ' + deserialized_property.downcase + ', but was received from the server.' unless enum_is_valid
  end
  output_object.resource_state = deserialized_property

  deserialized_property = object['provisioningState']
  if (!deserialized_property.nil? && !deserialized_property.empty?)
    enum_is_valid = ProvisioningState.constants.any? { |e| ProvisioningState.const_get(e).to_s.downcase == deserialized_property.downcase }
    warn 'Enum ProvisioningState does not contain ' + deserialized_property.downcase + ', but was received from the server.' unless enum_is_valid
  end
  output_object.provisioning_state = deserialized_property

  output_object
end

.serialize_object(object) ⇒ Hash

Serializes given Model object into Ruby Hash.

Parameters:

  • object —

    Model object to serialize.

Returns:

  • (Hash) —

    Serialized object in form of Ruby Hash.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 79

def self.serialize_object(object)
  object.validate
  output_object = {}

  serialized_property = object.host_name
  output_object['hostName'] = serialized_property unless serialized_property.nil?

  serialized_property = object.origin_host_header
  output_object['originHostHeader'] = serialized_property unless serialized_property.nil?

  serialized_property = object.origin_path
  output_object['originPath'] = serialized_property unless serialized_property.nil?

  serialized_property = object.content_types_to_compress
  output_object['contentTypesToCompress'] = serialized_property unless serialized_property.nil?

  serialized_property = object.is_compression_enabled
  output_object['isCompressionEnabled'] = serialized_property unless serialized_property.nil?

  serialized_property = object.is_http_allowed
  output_object['isHttpAllowed'] = serialized_property unless serialized_property.nil?

  serialized_property = object.is_https_allowed
  output_object['isHttpsAllowed'] = serialized_property unless serialized_property.nil?

  serialized_property = object.query_string_caching_behavior
  output_object['queryStringCachingBehavior'] = serialized_property unless serialized_property.nil?

  serialized_property = object.origins
  unless serialized_property.nil?
    serializedArray = []
    serialized_property.each do |element1|
      unless element1.nil?
        element1 = DeepCreatedOrigin.serialize_object(element1)
      end
      serializedArray.push(element1)
    end
    serialized_property = serializedArray
  end
  output_object['origins'] = serialized_property unless serialized_property.nil?

  serialized_property = object.resource_state
  output_object['resourceState'] = serialized_property unless serialized_property.nil?

  serialized_property = object.provisioning_state
  output_object['provisioningState'] = serialized_property unless serialized_property.nil?

  output_object
end

Instance Method Details

#validate ⇒ Object

Validate the object. Throws ValidationError if validation fails.



69
70
71
72
 
# File 'lib/azure_mgmt_cdn/models/endpoint_properties.rb', line 69

def validate
  @content_types_to_compress.each{ |e| e.validate if e.respond_to?(:validate) } unless @content_types_to_compress.nil?
  @origins.each{ |e| e.validate if e.respond_to?(:validate) } unless @origins.nil?
end