Package software.amazon.awssdk.services.partnercentralselling.model

Class GetEngagementResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingResponse

software.amazon.awssdk.services.partnercentralselling.model.GetEngagementResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetEngagementResponse.Builder,GetEngagementResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetEngagementResponse
extends PartnerCentralSellingResponse
implements ToCopyableBuilder<GetEngagementResponse.Builder,GetEngagementResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetEngagementResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the engagement retrieved.
static GetEngagementResponse.Builder	builder()
List<EngagementContextDetails>	contexts()	A list of context objects associated with the engagement.
Instant	createdAt()	The date and time when the Engagement was created, presented in ISO 8601 format (UTC).
String	createdBy()	The AWS account ID of the user who originally created the engagement.
String	description()	A more detailed description of the engagement.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContexts()	For responses, this returns true if the service returned a value for the Contexts property.
int	hashCode()
String	id()	The unique resource identifier of the engagement retrieved.
Integer	memberCount()	Specifies the current count of members participating in the Engagement.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetEngagementResponse.Builder>	serializableBuilderClass()
String	title()	The title of the engagement.
GetEngagementResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

The Amazon Resource Name (ARN) of the engagement retrieved.

Returns:

The Amazon Resource Name (ARN) of the engagement retrieved.

hasContexts

public final boolean hasContexts()

For responses, this returns true if the service returned a value for the Contexts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

contexts

public final List<EngagementContextDetails> contexts()

A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContexts() method.

Returns:

A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

createdAt

public final Instant createdAt()

The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.

Returns:

The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.

createdBy

public final String createdBy()

The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.

Returns:

The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.

description

public final String description()

A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.

Returns:

A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.

id

public final String id()

The unique resource identifier of the engagement retrieved.

Returns:

The unique resource identifier of the engagement retrieved.

memberCount

public final Integer memberCount()

Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.

Returns:

Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.

title

public final String title()

The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.

Returns:

The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.

toBuilder

public GetEngagementResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetEngagementResponse.Builder,GetEngagementResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetEngagementResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetEngagementResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo