class Azure::EventGrid::V2018_01_01::EventGridClient
A service client - single point of access to the REST API.
Attributes
@return [String] The preferred language for the response.
@return [String] Version of the API to be used with the client request.
@return [String] the base URI of the service.
@return Credentials needed for the client to connect to Azure
.
@return [Boolean] Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.
@return [Integer] The retry timeout in seconds for Long Running Operations. Default value is 30.
Public Class Methods
Creates initializes a new instance of the EventGridClient
class. @param credentials [MsRest::ServiceClientCredentials] credentials to authorize HTTP requests made by the service client. @param options [Array] filters to be applied to the HTTP requests.
# File lib/2018-01-01/generated/azure_event_grid/event_grid_client.rb, line 40 def initialize(credentials = nil, options = nil) super(credentials, options) @base_url = 'https://{topicHostname}' fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil? @credentials = credentials @api_version = '2018-01-01' @accept_language = 'en-US' @long_running_operation_retry_timeout = 30 @generate_client_request_id = true add_telemetry end
Public Instance Methods
Makes a request and returns the body of the response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Hash{String=>String}] containing 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)
# File lib/2018-01-01/generated/azure_event_grid/event_grid_client.rb, line 70 def make_request(method, path, options = {}) result = make_request_with_http_info(method, path, options) result.body unless result.nil? end
Makes a request asynchronously. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2018-01-01/generated/azure_event_grid/event_grid_client.rb, line 95 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
Makes a request and returns the operation response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.
# File lib/2018-01-01/generated/azure_event_grid/event_grid_client.rb, line 82 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
Publishes a batch of events to an Azure
Event Grid topic.
@param topic_hostname [String] The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net @param events [Array<EventGridEvent>] An array of events to be published to Event Grid. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
# File lib/2018-01-01/generated/azure_event_grid/event_grid_client.rb, line 123 def publish_events(topic_hostname, events, custom_headers:nil) response = publish_events_async(topic_hostname, events, custom_headers:custom_headers).value! nil end
Publishes a batch of events to an Azure
Event Grid topic.
@param topic_hostname [String] The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net @param events [Array<EventGridEvent>] An array of events to be published to Event Grid. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2018-01-01/generated/azure_event_grid/event_grid_client.rb, line 156 def publish_events_async(topic_hostname, events, custom_headers:nil) fail ArgumentError, 'topic_hostname is nil' if topic_hostname.nil? fail ArgumentError, 'events is nil' if events.nil? fail ArgumentError, 'api_version is nil' if api_version.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = accept_language unless accept_language.nil? # Serialize Request request_mapper = { client_side_validation: true, required: true, serialized_name: 'events', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'EventGridEventElementType', type: { name: 'Composite', class_name: 'EventGridEvent' } } } } request_content = self.serialize(request_mapper, events) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'api/events' request_url = @base_url || self.base_url request_url = request_url.gsub('{topicHostname}', topic_hostname) options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], query_params: {'api-version' => api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = self.make_request_async(:post, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? result end promise.execute end
Publishes a batch of events to an Azure
Event Grid topic.
@param topic_hostname [String] The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net @param events [Array<EventGridEvent>] An array of events to be published to Event Grid. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2018-01-01/generated/azure_event_grid/event_grid_client.rb, line 140 def publish_events_with_http_info(topic_hostname, events, custom_headers:nil) publish_events_async(topic_hostname, events, custom_headers:custom_headers).value! end
Private Instance Methods
Adds telemetry information.
# File lib/2018-01-01/generated/azure_event_grid/event_grid_client.rb, line 228 def add_telemetry sdk_information = 'azure_event_grid' sdk_information = "#{sdk_information}/0.18.1" add_user_agent_information(sdk_information) end