Package software.amazon.awssdk.services.cleanrooms.model

Class CreatePrivacyBudgetTemplateRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cleanrooms.model.CleanRoomsRequest
software.amazon.awssdk.services.cleanrooms.model.CreatePrivacyBudgetTemplateRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePrivacyBudgetTemplateRequest.Builder,CreatePrivacyBudgetTemplateRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePrivacyBudgetTemplateRequest extends CleanRoomsRequest implements ToCopyableBuilder<CreatePrivacyBudgetTemplateRequest.Builder,CreatePrivacyBudgetTemplateRequest>

  • Method Details

    • membershipIdentifier

      public final String membershipIdentifier()

      A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.

      Returns:
      A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.

    • autoRefresh

      public final PrivacyBudgetTemplateAutoRefresh autoRefresh()

      How often the privacy budget refreshes.

      If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

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

      Returns:
      How often the privacy budget refreshes.

      If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

      See Also:

    • autoRefreshAsString

      public final String autoRefreshAsString()

      How often the privacy budget refreshes.

      If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

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

      Returns:
      How often the privacy budget refreshes.

      If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

      See Also:

    • privacyBudgetType

      public final PrivacyBudgetType privacyBudgetType()

      Specifies the type of the privacy budget template.

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

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

    • privacyBudgetTypeAsString

      public final String privacyBudgetTypeAsString()

      Specifies the type of the privacy budget template.

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

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

    • parameters

      public final PrivacyBudgetTemplateParametersInput parameters()

      Specifies your parameters for the privacy budget template.

      Returns:
      Specifies your parameters for the privacy budget template.

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

    • tags

      public final Map<String,String> tags()

      An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

      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:
      An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

    • toBuilder

      public CreatePrivacyBudgetTemplateRequest.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<CreatePrivacyBudgetTemplateRequest.Builder,CreatePrivacyBudgetTemplateRequest>
      Specified by:
      toBuilder in class CleanRoomsRequest
      Returns:
      a builder for type T

    • builder

      public static CreatePrivacyBudgetTemplateRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      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.