Class PermissionTemplateParameter

java.lang.Object
software.amazon.awssdk.services.ram.model.PermissionTemplateParameter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PermissionTemplateParameter.Builder,PermissionTemplateParameter>
@Generated("software.amazon.awssdk:codegen") public final class PermissionTemplateParameter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PermissionTemplateParameter.Builder,PermissionTemplateParameter>

Contains the declaration of a template parameter for a customer managed permission. When returned in the context of a permission association, it also includes the values assigned to that parameter.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the template parameter.

      Returns:
      The name of the template parameter.

    • type

      public final PermissionTemplateParameterType type()

      The type of the template parameter. This can be one of the following values:

      • STRING – A single string value.

      • STRING_LIST – One or more string values.

      If the service returns an enum value that is not available in the current SDK version, type will return PermissionTemplateParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the template parameter. This can be one of the following values:

      • STRING – A single string value.

      • STRING_LIST – One or more string values.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the template parameter. This can be one of the following values:

      • STRING – A single string value.

      • STRING_LIST – One or more string values.

      If the service returns an enum value that is not available in the current SDK version, type will return PermissionTemplateParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the template parameter. This can be one of the following values:

      • STRING – A single string value.

      • STRING_LIST – One or more string values.

      See Also:

    • description

      public final String description()

      A description of the template parameter.

      Returns:
      A description of the template parameter.

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values 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.

    • values

      public final List<String> values()

      The values assigned to this template parameter in the context of a permission association. This field is present only when the parameter has been assigned values (for example, in the response from ListPermissionAssociations or ListResourceSharePermissions).

      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 hasValues() method.

      Returns:
      The values assigned to this template parameter in the context of a permission association. This field is present only when the parameter has been assigned values (for example, in the response from ListPermissionAssociations or ListResourceSharePermissions).

    • toBuilder

      public PermissionTemplateParameter.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PermissionTemplateParameter.Builder,PermissionTemplateParameter>
      Returns:
      a builder for type T

    • builder

      public static PermissionTemplateParameter.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.