Interface RegisterAppInstanceUserEndpointRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ChimeSdkIdentityRequest.Builder, CopyableBuilder<RegisterAppInstanceUserEndpointRequest.Builder,RegisterAppInstanceUserEndpointRequest>, SdkBuilder<RegisterAppInstanceUserEndpointRequest.Builder,RegisterAppInstanceUserEndpointRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RegisterAppInstanceUserEndpointRequest
@Mutable @NotThreadSafe public static interface RegisterAppInstanceUserEndpointRequest.Builder extends ChimeSdkIdentityRequest.Builder, SdkPojo, CopyableBuilder<RegisterAppInstanceUserEndpointRequest.Builder,RegisterAppInstanceUserEndpointRequest>

  • Method Details

    • appInstanceUserArn

      RegisterAppInstanceUserEndpointRequest.Builder appInstanceUserArn(String appInstanceUserArn)

      The ARN of the AppInstanceUser.

      Parameters:
      appInstanceUserArn - The ARN of the AppInstanceUser.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      RegisterAppInstanceUserEndpointRequest.Builder name(String name)

      The name of the AppInstanceUserEndpoint.

      Parameters:
      name - The name of the AppInstanceUserEndpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      RegisterAppInstanceUserEndpointRequest.Builder type(String type)

      The type of the AppInstanceUserEndpoint. Supported types:

      • APNS: The mobile notification service for an Apple device.

      • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

      • GCM: The mobile notification service for an Android device.

      Populate the ResourceArn value of each type as PinpointAppArn.

      Parameters:
      type - The type of the AppInstanceUserEndpoint. Supported types:

      • APNS: The mobile notification service for an Apple device.

      • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

      • GCM: The mobile notification service for an Android device.

      Populate the ResourceArn value of each type as PinpointAppArn.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      RegisterAppInstanceUserEndpointRequest.Builder type(AppInstanceUserEndpointType type)

      The type of the AppInstanceUserEndpoint. Supported types:

      • APNS: The mobile notification service for an Apple device.

      • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

      • GCM: The mobile notification service for an Android device.

      Populate the ResourceArn value of each type as PinpointAppArn.

      Parameters:
      type - The type of the AppInstanceUserEndpoint. Supported types:

      • APNS: The mobile notification service for an Apple device.

      • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

      • GCM: The mobile notification service for an Android device.

      Populate the ResourceArn value of each type as PinpointAppArn.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceArn

      RegisterAppInstanceUserEndpointRequest.Builder resourceArn(String resourceArn)

      The ARN of the resource to which the endpoint belongs.

      Parameters:
      resourceArn - The ARN of the resource to which the endpoint belongs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointAttributes

      RegisterAppInstanceUserEndpointRequest.Builder endpointAttributes(EndpointAttributes endpointAttributes)

      The attributes of an Endpoint.

      Parameters:
      endpointAttributes - The attributes of an Endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointAttributes

      default RegisterAppInstanceUserEndpointRequest.Builder endpointAttributes(Consumer<EndpointAttributes.Builder> endpointAttributes)

      The attributes of an Endpoint.

      This is a convenience method that creates an instance of the EndpointAttributes.Builder avoiding the need to create one manually via EndpointAttributes.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpointAttributes(EndpointAttributes).

      Parameters:
      endpointAttributes - a consumer that will call methods on EndpointAttributes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientRequestToken

      RegisterAppInstanceUserEndpointRequest.Builder clientRequestToken(String clientRequestToken)

      The unique ID assigned to the request. Use different tokens to register other endpoints.

      Parameters:
      clientRequestToken - The unique ID assigned to the request. Use different tokens to register other endpoints.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowMessages

      RegisterAppInstanceUserEndpointRequest.Builder allowMessages(String allowMessages)

      Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.

      Parameters:
      allowMessages - Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • allowMessages

      RegisterAppInstanceUserEndpointRequest.Builder allowMessages(AllowMessages allowMessages)

      Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.

      Parameters:
      allowMessages - Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      RegisterAppInstanceUserEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RegisterAppInstanceUserEndpointRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.