Package com.google.cloud.retail.v2

Interface WriteUserEventRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    WriteUserEventRequest, WriteUserEventRequest.Builder
    public interface WriteUserEventRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      UserEvent getUserEvent()
      Required.
      UserEventOrBuilder getUserEventOrBuilder()
      Required.
      boolean getWriteAsync()
      If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write.
      boolean hasUserEvent()
      Required.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        String getParent()
         Required. The parent catalog resource name, such as
 `projects/1234/locations/global/catalogs/default_catalog`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The parent catalog resource name, such as
 `projects/1234/locations/global/catalogs/default_catalog`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for parent.

      • hasUserEvent

        boolean hasUserEvent()
         Required. User event to write.
        .google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the userEvent field is set.

      • getUserEvent

        UserEvent getUserEvent()
         Required. User event to write.
        .google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The userEvent.

      • getUserEventOrBuilder

        UserEventOrBuilder getUserEventOrBuilder()
         Required. User event to write.
        .google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

      • getWriteAsync

        boolean getWriteAsync()
         If set to true, the user event will be written asynchronously after
 validation, and the API will respond without waiting for the write.
 Therefore, silent failures can occur even if the API returns success. In
 case of silent failures, error messages can be found in Stackdriver logs.
        bool write_async = 3;
        Returns:
        The writeAsync.