Class CreateAgentOrganizationalProfileRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateAgentOrganizationalProfileRequest.Builder,CreateAgentOrganizationalProfileRequest>
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final StringThe business overview for this organizational profile.final StringA unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final BooleanIndicates whether deletion protection is enabled for the organizational profile.final StringA description of the organizational profile.final StringThe display name of the organizational profile shown to users.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 extendsSdkRequest.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the Pillars property.final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final Stringname()The system name of the organizational profile.The organizational monitoring boundary.pillars()The Amazon Web Services Well-Architected Framework pillars to associate with this organizational profile.The Amazon Web Services Well-Architected Framework pillars to associate with this organizational profile.static Class<? extends CreateAgentOrganizationalProfileRequest.Builder> tags()The tags to associate with the organizational profile.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The system name of the organizational profile.
- Returns:
- The system name of the organizational profile.
-
displayName
The display name of the organizational profile shown to users.
- Returns:
- The display name of the organizational profile shown to users.
-
description
A description of the organizational profile.
- Returns:
- A description of the organizational profile.
-
businessOverview
The business overview for this organizational profile.
- Returns:
- The business overview for this organizational profile.
-
pillars
The Amazon Web Services Well-Architected Framework pillars to associate with this organizational profile.
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
hasPillars()method.- Returns:
- The Amazon Web Services Well-Architected Framework pillars to associate with this organizational profile.
-
hasPillars
public final boolean hasPillars()For responses, this returns true if the service returned a value for the Pillars 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. -
pillarsAsStrings
The Amazon Web Services Well-Architected Framework pillars to associate with this organizational profile.
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
hasPillars()method.- Returns:
- The Amazon Web Services Well-Architected Framework pillars to associate with this organizational profile.
-
deletionProtection
Indicates whether deletion protection is enabled for the organizational profile.
- Returns:
- Indicates whether deletion protection is enabled for the organizational profile.
-
clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Returns:
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
-
organizationalAggregationConfiguration
The organizational monitoring boundary. Contains organizational unit or root entries and individual account entries that define the scope for the profile.
- Returns:
- The organizational monitoring boundary. Contains organizational unit or root entries and individual account entries that define the scope for the profile.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
The tags to associate with the organizational profile.
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
hasTags()method.- Returns:
- The tags to associate with the organizational profile.
-
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<CreateAgentOrganizationalProfileRequest.Builder,CreateAgentOrganizationalProfileRequest> - Specified by:
toBuilderin classWellArchitectedRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateAgentOrganizationalProfileRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
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:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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.
-