Class GetApprovalTeamResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetApprovalTeamResponse.Builder,GetApprovalTeamResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal ApprovalStrategyResponseAnApprovalStrategyResponseobject.An array ofGetApprovalTeamResponseApproverobjects.final Stringarn()Amazon Resource Name (ARN) for the team.builder()final InstantTimestamp when the team was created.final StringDescription for the team.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse.final booleanFor responses, this returns true if the service returned a value for the Approvers property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the Policies property.final InstantTimestamp when the team was last updated.final Stringname()Name of the approval team.final IntegerTotal number of approvers in the team.final PendingUpdateAPendingUpdateobject.final List<PolicyReference> policies()An array ofPolicyReferenceobjects.static Class<? extends GetApprovalTeamResponse.Builder> final ApprovalTeamStatusstatus()Status for the team.final StringStatus for the team.final ApprovalTeamStatusCodeStatus code for the approval team.final StringStatus code for the approval team.final StringMessage describing the status for the team.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final StringAmazon Resource Name (ARN) for the session.final StringVersion ID for the team.Methods inherited from class software.amazon.awssdk.services.mpa.model.MpaResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
creationTime
Timestamp when the team was created.
- Returns:
- Timestamp when the team was created.
-
approvalStrategy
An
ApprovalStrategyResponseobject. Contains details for how the team grants approval.- Returns:
- An
ApprovalStrategyResponseobject. Contains details for how the team grants approval.
-
numberOfApprovers
Total number of approvers in the team.
- Returns:
- Total number of approvers in the team.
-
hasApprovers
public final boolean hasApprovers()For responses, this returns true if the service returned a value for the Approvers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
approvers
An array of
GetApprovalTeamResponseApproverobjects. Contains details for the approvers in the team.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
hasApprovers()method.- Returns:
- An array of
GetApprovalTeamResponseApproverobjects. Contains details for the approvers in the team.
-
arn
Amazon Resource Name (ARN) for the team.
- Returns:
- Amazon Resource Name (ARN) for the team.
-
description
-
name
-
status
Status for the team. For more information, see Team health in the Multi-party approval User Guide.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnApprovalTeamStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Status for the team. For more information, see Team health in the Multi-party approval User Guide.
- See Also:
-
statusAsString
Status for the team. For more information, see Team health in the Multi-party approval User Guide.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnApprovalTeamStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Status for the team. For more information, see Team health in the Multi-party approval User Guide.
- See Also:
-
statusCode
Status code for the approval team. For more information, see Team health in the Multi-party approval User Guide.
If the service returns an enum value that is not available in the current SDK version,
statusCodewill returnApprovalTeamStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusCodeAsString().- Returns:
- Status code for the approval team. For more information, see Team health in the Multi-party approval User Guide.
- See Also:
-
statusCodeAsString
Status code for the approval team. For more information, see Team health in the Multi-party approval User Guide.
If the service returns an enum value that is not available in the current SDK version,
statusCodewill returnApprovalTeamStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusCodeAsString().- Returns:
- Status code for the approval team. For more information, see Team health in the Multi-party approval User Guide.
- See Also:
-
statusMessage
Message describing the status for the team.
- Returns:
- Message describing the status for the team.
-
updateSessionArn
Amazon Resource Name (ARN) for the session.
- Returns:
- Amazon Resource Name (ARN) for the session.
-
versionId
-
hasPolicies
public final boolean hasPolicies()For responses, this returns true if the service returned a value for the Policies property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
policies
An array of
PolicyReferenceobjects. Contains a list of policies that define the permissions for team resources.The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
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
hasPolicies()method.- Returns:
- An array of
PolicyReferenceobjects. Contains a list of policies that define the permissions for team resources.The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
-
lastUpdateTime
Timestamp when the team was last updated.
- Returns:
- Timestamp when the team was last updated.
-
pendingUpdate
A
PendingUpdateobject. Contains details for the pending updates for the team, if applicable.- Returns:
- A
PendingUpdateobject. Contains details for the pending updates for the team, if applicable.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GetApprovalTeamResponse.Builder,GetApprovalTeamResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsResponse
-
equals
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkResponseUsed to retrieve the value of a field from any class that extendsSdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkResponse- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-