Class PrivacyBudgetSummary

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

An array that summaries the specified privacy budget. This summary includes collaboration information, creation information, membership information, and privacy budget information.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the privacy budget.

      Returns:
      The unique identifier of the privacy budget.

    • privacyBudgetTemplateId

      public final String privacyBudgetTemplateId()

      The unique identifier of the privacy budget template.

      Returns:
      The unique identifier of the privacy budget template.

    • privacyBudgetTemplateArn

      public final String privacyBudgetTemplateArn()

      The ARN of the privacy budget template.

      Returns:
      The ARN of the privacy budget template.

    • membershipId

      public final String membershipId()

      The identifier for a membership resource.

      Returns:
      The identifier for a membership resource.

    • membershipArn

      public final String membershipArn()

      The Amazon Resource Name (ARN) of the member who created the privacy budget summary.

      Returns:
      The Amazon Resource Name (ARN) of the member who created the privacy budget summary.

    • collaborationId

      public final String collaborationId()

      The unique identifier of the collaboration that contains this privacy budget.

      Returns:
      The unique identifier of the collaboration that contains this privacy budget.

    • collaborationArn

      public final String collaborationArn()

      The ARN of the collaboration that contains this privacy budget.

      Returns:
      The ARN of the collaboration that contains this privacy budget.

    • type

      public final PrivacyBudgetType type()

      Specifies the type of the privacy budget.

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

      Returns:
      Specifies the type of the privacy budget.
      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies the type of the privacy budget.

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

      Returns:
      Specifies the type of the privacy budget.
      See Also:

    • createTime

      public final Instant createTime()

      The time at which the privacy budget was created.

      Returns:
      The time at which the privacy budget was created.

    • updateTime

      public final Instant updateTime()

      The most recent time at which the privacy budget was updated.

      Returns:
      The most recent time at which the privacy budget was updated.

    • budget

      public final PrivacyBudget budget()

      The provided privacy budget.

      Returns:
      The provided privacy budget.

    • toBuilder

      public PrivacyBudgetSummary.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<PrivacyBudgetSummary.Builder,PrivacyBudgetSummary>
      Returns:
      a builder for type T

    • builder

      public static PrivacyBudgetSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PrivacyBudgetSummary.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.