Class: Azure::RecoveryServicesBackup::Mgmt::V2017_07_01::RecoveryServicesBackupClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.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) ⇒ RecoveryServicesBackupClient

Creates initializes a new instance of the RecoveryServicesBackupClient 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.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 81

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

  @protection_intent_operations = ProtectionIntentOperations.new(self)
  @backup_status = BackupStatus.new(self)
  @feature_support = FeatureSupport.new(self)
  @backup_jobs = BackupJobs.new(self)
  @job_details = JobDetails.new(self)
  @export_jobs_operation_results = ExportJobsOperationResults.new(self)
  @jobs = Jobs.new(self)
  @backup_policies = BackupPolicies.new(self)
  @backup_protected_items = BackupProtectedItems.new(self)
  @backup_usage_summaries = BackupUsageSummaries.new(self)
  @operation = Operation.new(self)
  @api_version = '2017-07-01'
  @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.



31
32
33
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 31

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns Client Api Version.

Returns:

  • (String) —

    Client Api Version.



28
29
30
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 28

def api_version
  @api_version
end

#backup_jobs ⇒ BackupJobs (readonly)

Returns backup_jobs.

Returns:



52
53
54
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 52

def backup_jobs
  @backup_jobs
end

#backup_policies ⇒ BackupPolicies (readonly)

Returns backup_policies.

Returns:



64
65
66
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 64

def backup_policies
  @backup_policies
end

#backup_protected_items ⇒ BackupProtectedItems (readonly)

Returns backup_protected_items.

Returns:



67
68
69
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 67

def backup_protected_items
  @backup_protected_items
end

#backup_status ⇒ BackupStatus (readonly)

Returns backup_status.

Returns:



46
47
48
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 46

def backup_status
  @backup_status
end

#backup_usage_summaries ⇒ BackupUsageSummaries (readonly)

Returns backup_usage_summaries.

Returns:



70
71
72
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 70

def backup_usage_summaries
  @backup_usage_summaries
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



19
20
21
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 19

def base_url
  @base_url
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



22
23
24
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 22

def credentials
  @credentials
end

#export_jobs_operation_results ⇒ ExportJobsOperationResults (readonly)

Returns export_jobs_operation_results.

Returns:



58
59
60
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 58

def export_jobs_operation_results
  @export_jobs_operation_results
end

#feature_support ⇒ FeatureSupport (readonly)

Returns feature_support.

Returns:



49
50
51
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 49

def feature_support
  @feature_support
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



40
41
42
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 40

def generate_client_request_id
  @generate_client_request_id
end

#job_details ⇒ JobDetails (readonly)

Returns job_details.

Returns:



55
56
57
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 55

def job_details
  @job_details
end

#jobs ⇒ Jobs (readonly)

Returns jobs.

Returns:



61
62
63
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 61

def jobs
  @jobs
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



35
36
37
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 35

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operation ⇒ Operation (readonly)

Returns operation.

Returns:



73
74
75
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 73

def operation
  @operation
end

#protection_intent_operations ⇒ ProtectionIntentOperations (readonly)

Returns protection_intent_operations.

Returns:



43
44
45
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 43

def protection_intent_operations
  @protection_intent_operations
end

#subscription_id ⇒ String

Returns The subscription Id.

Returns:

  • (String) —

    The subscription Id.



25
26
27
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 25

def subscription_id
  @subscription_id
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.



122
123
124
125
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 122

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.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 147

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.



134
135
136
137
138
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/recovery_services_backup_client.rb', line 134

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