Class: Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest

Inherits:

Object

• Object
• Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/recommendationengine_v1beta1/classes.rb,
generated/google/apis/recommendationengine_v1beta1/representations.rb,
generated/google/apis/recommendationengine_v1beta1/representations.rb

Overview

Request message for PurgeUserEvents method.

Instance Attribute Summary

• #filter ⇒ String

  Required.

• #force ⇒ Boolean (also: #force?)

  Optional.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest constructor

  A new instance of GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest

Returns a new instance of GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest.

# File 'generated/google/apis/recommendationengine_v1beta1/classes.rb', line 1526

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#filter ⇒ String

Required. The filter string to specify the events to be deleted. Empty string filter is not allowed. The eligible fields for filtering are: * eventType: UserEvent.eventType field of type string. * eventTime: in ISO 8601 "zulu" format. * visitorId: field of type string. Specifying this will delete all events associated with a visitor. * userId: field of type string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: eventTime > "2012-04-23T18:25:43.511Z" eventTime < " 2012-04-23T18:30:43.511Z" * Deleting specific eventType in time range: eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view" * Deleting all events for a specific visitor: visitorId = "visitor1024" The filtering fields are assumed to have an implicit AND. Corresponds to the JSON property filter

Returns:

• (String)

# File 'generated/google/apis/recommendationengine_v1beta1/classes.rb', line 1516

def filter
  @filter
end

#force ⇒ Boolean Also known as: force?

Optional. The default value is false. Override this flag to true to actually perform the purge. If the field is not set to true, a sampling of events to be deleted will be returned. Corresponds to the JSON property force

Returns:

• (Boolean)

# File 'generated/google/apis/recommendationengine_v1beta1/classes.rb', line 1523

def force
  @force
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/recommendationengine_v1beta1/classes.rb', line 1531

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
  @force = args[:force] if args.key?(:force)
end