View Source GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceIdentity (google_api_content_warehouse v0.4.0)

The set of information that helps the server identify the surface. This replaces the User-Agent string within the Assistant Server. Note: The SurfaceIdentity proto should only be used to derive the capabilities of a surface. It should not be accessed outside of the CapabilityBuilder or CapabilityChecker. NEXT ID: 6

Attributes

  • deviceId (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t, default: nil) - The identifier of the device.
  • legacySurfaceType (type: String.t, default: nil) - DEPRECATED: The legacy device's surface type enum. NOTE: Prefer using the ontological surface_type field above. If you need to access the legacy surface type, please file a bug and add it in your code to migrate to ontological surface type.
  • surfaceType (type: String.t, default: nil) - The device's surface type. The types are defined at google3/assistant/api/core_types/surfaces.gcl. For more details, refer to go/ontologicalize-surface-type.
  • surfaceTypeString (type: String.t, default: nil) - DEPRECATED. The legacy device's surface type string. NOTE: Prefer using the ontological surface_type field. The device's surface type. This is the string version of the assistant.api.core_types.SurfaceType enum. The server should not use this field, rather it should use the SurfaceType value derived from this string.
  • surfaceVersion (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceVersion.t, default: nil) - The version of the surface/client. This is different from the Conversation protocol version.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceIdentity{
    deviceId:
      GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t()
      | nil,
    legacySurfaceType: String.t() | nil,
    surfaceType: String.t() | nil,
    surfaceTypeString: String.t() | nil,
    surfaceVersion:
      GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceVersion.t()
      | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.