Cloud Talent Solution V4 API - Class Google::Cloud::Talent::V4::EventService::Rest::Client (v1.1.0)

Reference documentation and code samples for the Cloud Talent Solution V4 API class Google::Cloud::Talent::V4::EventService::Rest::Client.

REST client for the EventService service.

A service handles client event report.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the EventService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all EventService clients
::Google::Cloud::Talent::V4::EventService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the EventService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_client_event

def create_client_event(request, options = nil) -> ::Google::Cloud::Talent::V4::ClientEvent
def create_client_event(parent: nil, client_event: nil) -> ::Google::Cloud::Talent::V4::ClientEvent

Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in self service tools. Learn more about self service tools.

Overloads 
def create_client_event(request, options = nil) -> ::Google::Cloud::Talent::V4::ClientEvent
Pass arguments to create_client_event via a request object, either of type CreateClientEventRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Talent::V4::CreateClientEventRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_client_event(parent: nil, client_event: nil) -> ::Google::Cloud::Talent::V4::ClientEvent
Pass arguments to create_client_event via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Resource name of the tenant under which the event is created.

    The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

  • client_event (::Google::Cloud::Talent::V4::ClientEvent, ::Hash) — Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/talent/v4"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Talent::V4::EventService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Talent::V4::CreateClientEventRequest.new

# Call the create_client_event method.
result = client.create_client_event request

# The returned object is of type Google::Cloud::Talent::V4::ClientEvent.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new EventService REST client object.

Yields
  • (config) — Configure the EventService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Talent::V4::EventService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Talent::V4::EventService::Rest::Client.new do |config|
  config.timeout = 10.0
end

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)