Interface AppInstanceUserEndpoint.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AppInstanceUserEndpoint.Builder,
,AppInstanceUserEndpoint> SdkBuilder<AppInstanceUserEndpoint.Builder,
,AppInstanceUserEndpoint> SdkPojo
- Enclosing class:
AppInstanceUserEndpoint
-
Method Summary
Modifier and TypeMethodDescriptionallowMessages
(String allowMessages) Boolean that controls whether theAppInstanceUserEndpoint
is opted in to receive messages.allowMessages
(AllowMessages allowMessages) Boolean that controls whether theAppInstanceUserEndpoint
is opted in to receive messages.appInstanceUserArn
(String appInstanceUserArn) The ARN of theAppInstanceUser
.createdTimestamp
(Instant createdTimestamp) The time at which anAppInstanceUserEndpoint
was created.default AppInstanceUserEndpoint.Builder
endpointAttributes
(Consumer<EndpointAttributes.Builder> endpointAttributes) The attributes of anEndpoint
.endpointAttributes
(EndpointAttributes endpointAttributes) The attributes of anEndpoint
.endpointId
(String endpointId) The unique identifier of theAppInstanceUserEndpoint
.default AppInstanceUserEndpoint.Builder
endpointState
(Consumer<EndpointState.Builder> endpointState) A read-only field that represents the state of anAppInstanceUserEndpoint
.endpointState
(EndpointState endpointState) A read-only field that represents the state of anAppInstanceUserEndpoint
.lastUpdatedTimestamp
(Instant lastUpdatedTimestamp) The time at which anAppInstanceUserEndpoint
was last updated.The name of theAppInstanceUserEndpoint
.resourceArn
(String resourceArn) The ARN of the resource to which the endpoint belongs.The type of theAppInstanceUserEndpoint
.The type of theAppInstanceUserEndpoint
.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
appInstanceUserArn
The ARN of the
AppInstanceUser
.- Parameters:
appInstanceUserArn
- The ARN of theAppInstanceUser
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpointId
The unique identifier of the
AppInstanceUserEndpoint
.- Parameters:
endpointId
- The unique identifier of theAppInstanceUserEndpoint
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name of the
AppInstanceUserEndpoint
.- Parameters:
name
- The name of theAppInstanceUserEndpoint
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The type of the
AppInstanceUserEndpoint
.- Parameters:
type
- The type of theAppInstanceUserEndpoint
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The type of the
AppInstanceUserEndpoint
.- Parameters:
type
- The type of theAppInstanceUserEndpoint
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The attributes of an
Endpoint
.- Parameters:
endpointAttributes
- The attributes of anEndpoint
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpointAttributes
default AppInstanceUserEndpoint.Builder endpointAttributes(Consumer<EndpointAttributes.Builder> endpointAttributes) The attributes of an
This is a convenience method that creates an instance of theEndpoint
.EndpointAttributes.Builder
avoiding the need to create one manually viaEndpointAttributes.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toendpointAttributes(EndpointAttributes)
.- Parameters:
endpointAttributes
- a consumer that will call methods onEndpointAttributes.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdTimestamp
The time at which an
AppInstanceUserEndpoint
was created.- Parameters:
createdTimestamp
- The time at which anAppInstanceUserEndpoint
was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedTimestamp
The time at which an
AppInstanceUserEndpoint
was last updated.- Parameters:
lastUpdatedTimestamp
- The time at which anAppInstanceUserEndpoint
was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowMessages
Boolean that controls whether the
AppInstanceUserEndpoint
is opted in to receive messages.ALL
indicates the endpoint will receive all messages.NONE
indicates the endpoint will receive no messages.- Parameters:
allowMessages
- Boolean that controls whether theAppInstanceUserEndpoint
is opted in to receive messages.ALL
indicates the endpoint will receive all messages.NONE
indicates the endpoint will receive no messages.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
allowMessages
Boolean that controls whether the
AppInstanceUserEndpoint
is opted in to receive messages.ALL
indicates the endpoint will receive all messages.NONE
indicates the endpoint will receive no messages.- Parameters:
allowMessages
- Boolean that controls whether theAppInstanceUserEndpoint
is opted in to receive messages.ALL
indicates the endpoint will receive all messages.NONE
indicates the endpoint will receive no messages.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
endpointState
A read-only field that represents the state of an
AppInstanceUserEndpoint
. Supported values:-
ACTIVE
: TheAppInstanceUserEndpoint
is active and able to receive messages. WhenACTIVE
, theEndpointStatusReason
remains empty. -
INACTIVE
: TheAppInstanceUserEndpoint
is inactive and can't receive message. WhenINACTIVE
, the corresponding reason will be conveyed throughEndpointStatusReason
. -
INVALID_DEVICE_TOKEN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to invalid device token -
INVALID_PINPOINT_ARN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to an invalid pinpoint ARN that was input through theResourceArn
field.
- Parameters:
endpointState
- A read-only field that represents the state of anAppInstanceUserEndpoint
. Supported values:-
ACTIVE
: TheAppInstanceUserEndpoint
is active and able to receive messages. WhenACTIVE
, theEndpointStatusReason
remains empty. -
INACTIVE
: TheAppInstanceUserEndpoint
is inactive and can't receive message. WhenINACTIVE
, the corresponding reason will be conveyed throughEndpointStatusReason
. -
INVALID_DEVICE_TOKEN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to invalid device token -
INVALID_PINPOINT_ARN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to an invalid pinpoint ARN that was input through theResourceArn
field.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
endpointState
default AppInstanceUserEndpoint.Builder endpointState(Consumer<EndpointState.Builder> endpointState) A read-only field that represents the state of an
AppInstanceUserEndpoint
. Supported values:-
ACTIVE
: TheAppInstanceUserEndpoint
is active and able to receive messages. WhenACTIVE
, theEndpointStatusReason
remains empty. -
INACTIVE
: TheAppInstanceUserEndpoint
is inactive and can't receive message. WhenINACTIVE
, the corresponding reason will be conveyed throughEndpointStatusReason
. -
INVALID_DEVICE_TOKEN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to invalid device token -
INVALID_PINPOINT_ARN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to an invalid pinpoint ARN that was input through theResourceArn
field.
EndpointState.Builder
avoiding the need to create one manually viaEndpointState.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toendpointState(EndpointState)
.- Parameters:
endpointState
- a consumer that will call methods onEndpointState.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-