Class: Azure::MediaServices::Mgmt::V2018_06_01_preview::AzureMediaServices

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ AzureMediaServices

Creates initializes a new instance of the AzureMediaServices class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

  • base_url (String) (defaults to: nil) —

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



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
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 82

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @operations = Operations.new(self)
  @mediaservices = Mediaservices.new(self)
  @locations = Locations.new(self)
  @assets = Assets.new(self)
  @content_key_policies = ContentKeyPolicies.new(self)
  @transforms = Transforms.new(self)
  @jobs = Jobs.new(self)
  @streaming_policies = StreamingPolicies.new(self)
  @streaming_locators = StreamingLocators.new(self)
  @live_events = LiveEvents.new(self)
  @live_outputs = LiveOutputs.new(self)
  @streaming_endpoints = StreamingEndpoints.new(self)
  @api_version = '2018-06-01-preview'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



29
30
31
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 29

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

request.

Returns:

  • (String) —

    The Version of the API to be used with the client



26
27
28
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 26

def api_version
  @api_version
end

#assets ⇒ Assets (readonly)

Returns assets.

Returns:



50
51
52
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 50

def assets
  @assets
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 15

def base_url
  @base_url
end

#content_key_policies ⇒ ContentKeyPolicies (readonly)

Returns content_key_policies.

Returns:



53
54
55
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 53

def content_key_policies
  @content_key_policies
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 18

def credentials
  @credentials
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



38
39
40
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 38

def generate_client_request_id
  @generate_client_request_id
end

#jobs ⇒ Jobs (readonly)

Returns jobs.

Returns:



59
60
61
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 59

def jobs
  @jobs
end

#live_events ⇒ LiveEvents (readonly)

Returns live_events.

Returns:



68
69
70
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 68

def live_events
  @live_events
end

#live_outputs ⇒ LiveOutputs (readonly)

Returns live_outputs.

Returns:



71
72
73
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 71

def live_outputs
  @live_outputs
end

#locations ⇒ Locations (readonly)

Returns locations.

Returns:



47
48
49
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 47

def locations
  @locations
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



33
34
35
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 33

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#mediaservices ⇒ Mediaservices (readonly)

Returns mediaservices.

Returns:



44
45
46
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 44

def mediaservices
  @mediaservices
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



41
42
43
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 41

def operations
  @operations
end

#streaming_endpoints ⇒ StreamingEndpoints (readonly)

Returns streaming_endpoints.

Returns:



74
75
76
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 74

def streaming_endpoints
  @streaming_endpoints
end

#streaming_locators ⇒ StreamingLocators (readonly)

Returns streaming_locators.

Returns:



65
66
67
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 65

def streaming_locators
  @streaming_locators
end

#streaming_policies ⇒ StreamingPolicies (readonly)

Returns streaming_policies.

Returns:



62
63
64
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 62

def streaming_policies
  @streaming_policies
end

#subscription_id ⇒ String

subscription.

Returns:

  • (String) —

    The unique identifier for a Microsoft Azure



22
23
24
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 22

def subscription_id
  @subscription_id
end

#transforms ⇒ Transforms (readonly)

Returns transforms.

Returns:



56
57
58
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 56

def transforms
  @transforms
end

Instance Method Details

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



124
125
126
127
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 124

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 149

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



136
137
138
139
140
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/azure_media_services.rb', line 136

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end