Class: Azure::CDN::Mgmt::V2015_06_01::Models::Endpoint

Inherits:
TrackedResource show all
Includes:
MsRestAzure
Defined in:
lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb

Overview

CDN endpoint is the entity within a CDN profile containing configuration information regarding caching behaviors and origins. The CDN endpoint is exposed using the URL format <endpointname>.azureedge.net by default, but custom domains can also be created.

Instance Attribute Summary collapse

Attributes inherited from TrackedResource

#location, #tags

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Instance Attribute Details

#content_types_to_compress ⇒ Array<String>

be applied. The value for the elements should be a valid MIME type.

Returns:

  • (Array<String>) —

    List of content types on which compression will



31
32
33
 
# File 'lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb', line 31

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



19
20
21
 
# File 'lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb', line 19

def host_name
  @host_name
end

#is_compression_enabled ⇒ Boolean

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. Default



37
38
39
 
# File 'lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb', line 37

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



42
43
44
 
# File 'lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb', line 42

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



47
48
49
 
# File 'lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb', line 47

def is_https_allowed
  @is_https_allowed
end

#origin_host_header ⇒ String

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

Returns:

  • (String) —

    The host header the CDN provider will send along with



24
25
26
 
# File 'lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb', line 24

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.



27
28
29
 
# File 'lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb', line 27

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:



57
58
59
 
# File 'lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb', line 57

def origins
  @origins
end

#provisioning_state ⇒ ProvisioningState

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

Returns:



66
67
68
 
# File 'lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb', line 66

def provisioning_state
  @provisioning_state
end

#query_string_caching_behavior ⇒ QueryStringCachingBehavior

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

Returns:



52
53
54
 
# File 'lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb', line 52

def query_string_caching_behavior
  @query_string_caching_behavior
end

#resource_state ⇒ EndpointResourceState

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

Returns:



62
63
64
 
# File 'lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb', line 62

def resource_state
  @resource_state
end

Class Method Details

.mapper ⇒ Object

Mapper for Endpoint class as Ruby Hash. This will be used for serialization/deserialization.



73
74
75
76
77
78
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
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
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/2015-06-01/generated/azure_mgmt_cdn/models/endpoint.rb', line 73

def self.mapper()
  {
    required: false,
    serialized_name: 'Endpoint',
    type: {
      name: 'Composite',
      class_name: 'Endpoint',
      model_properties: {
        id: {
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          required: true,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        host_name: {
          required: false,
          read_only: true,
          serialized_name: 'properties.hostName',
          type: {
            name: 'String'
          }
        },
        origin_host_header: {
          required: false,
          serialized_name: 'properties.originHostHeader',
          type: {
            name: 'String'
          }
        },
        origin_path: {
          required: false,
          serialized_name: 'properties.originPath',
          type: {
            name: 'String'
          }
        },
        content_types_to_compress: {
          required: false,
          serialized_name: 'properties.contentTypesToCompress',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        is_compression_enabled: {
          required: false,
          serialized_name: 'properties.isCompressionEnabled',
          type: {
            name: 'Boolean'
          }
        },
        is_http_allowed: {
          required: false,
          serialized_name: 'properties.isHttpAllowed',
          type: {
            name: 'Boolean'
          }
        },
        is_https_allowed: {
          required: false,
          serialized_name: 'properties.isHttpsAllowed',
          type: {
            name: 'Boolean'
          }
        },
        query_string_caching_behavior: {
          required: false,
          serialized_name: 'properties.queryStringCachingBehavior',
          type: {
            name: 'Enum',
            module: 'QueryStringCachingBehavior'
          }
        },
        origins: {
          required: false,
          serialized_name: 'properties.origins',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'DeepCreatedOriginElementType',
                type: {
                  name: 'Composite',
                  class_name: 'DeepCreatedOrigin'
                }
            }
          }
        },
        resource_state: {
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceState',
          type: {
            name: 'Enum',
            module: 'EndpointResourceState'
          }
        },
        provisioning_state: {
          required: false,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        }
      }
    }
  }
end