java.lang.Object
- software.amazon.awssdk.services.cleanrooms.model.PrivacyBudgetTemplate

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<PrivacyBudgetTemplate.Builder,PrivacyBudgetTemplate>

@Generated("software.amazon.awssdk:codegen")
public final class PrivacyBudgetTemplate
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PrivacyBudgetTemplate.Builder,PrivacyBudgetTemplate>

An object that defines the privacy budget template.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PrivacyBudgetTemplate.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The ARN of the privacy budget template.
`PrivacyBudgetTemplateAutoRefresh`	`autoRefresh()`	How often the privacy budget refreshes.
`String`	`autoRefreshAsString()`	How often the privacy budget refreshes.
`static PrivacyBudgetTemplate.Builder`	`builder()`
`String`	`collaborationArn()`	The ARN of the collaboration that contains this privacy budget template.
`String`	`collaborationId()`	The unique ID of the collaboration that contains this privacy budget template.
`Instant`	`createTime()`	The time at which the privacy budget template was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()`	The unique identifier of the privacy budget template.
`String`	`membershipArn()`	The Amazon Resource Name (ARN) of the member who created the privacy budget template.
`String`	`membershipId()`	The identifier for a membership resource.
`PrivacyBudgetTemplateParametersOutput`	`parameters()`	Specifies the epislon and noise parameters for the privacy budget template.
`PrivacyBudgetType`	`privacyBudgetType()`	Specifies the type of the privacy budget template.
`String`	`privacyBudgetTypeAsString()`	Specifies the type of the privacy budget template.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PrivacyBudgetTemplate.Builder>`	`serializableBuilderClass()`
`PrivacyBudgetTemplate.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`updateTime()`	The most recent time at which the privacy budget template was updated.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - id
```
public final String id()
```
    The unique identifier of the privacy budget template.
    
    Returns:
    
    The unique identifier of the privacy budget template.
  - arn
```
public final String arn()
```
    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 template.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
  - collaborationId
```
public final String collaborationId()
```
    The unique ID of the collaboration that contains this privacy budget template.
    
    Returns:
    
    The unique ID of the collaboration that contains this privacy budget template.
  - collaborationArn
```
public final String collaborationArn()
```
    The ARN of the collaboration that contains this privacy budget template.
    
    Returns:
    
    The ARN of the collaboration that contains this privacy budget template.
  - createTime
```
public final Instant createTime()
```
    The time at which the privacy budget template was created.
    
    Returns:
    
    The time at which the privacy budget template was created.
  - updateTime
```
public final Instant updateTime()
```
    The most recent time at which the privacy budget template was updated.
    
    Returns:
    
    The most recent time at which the privacy budget template was updated.
  - 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:
    
    PrivacyBudgetType
  - 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:
    
    PrivacyBudgetType
  - autoRefresh
```
public final PrivacyBudgetTemplateAutoRefresh autoRefresh()
```
    How often the privacy budget refreshes.
    
    If you plan to regularly bring new data into the collaboration, 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 queried 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, 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 queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
    
    See Also:
    
    PrivacyBudgetTemplateAutoRefresh
  - autoRefreshAsString
```
public final String autoRefreshAsString()
```
    How often the privacy budget refreshes.
    
    If you plan to regularly bring new data into the collaboration, 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 queried 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, 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 queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
    
    See Also:
    
    PrivacyBudgetTemplateAutoRefresh
  - parameters
```
public final PrivacyBudgetTemplateParametersOutput parameters()
```
    Specifies the epislon and noise parameters for the privacy budget template.
    
    Returns:
    
    Specifies the epislon and noise parameters for the privacy budget template.
  - toBuilder
```
public PrivacyBudgetTemplate.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PrivacyBudgetTemplate.Builder,PrivacyBudgetTemplate>
  - builder
```
public static PrivacyBudgetTemplate.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PrivacyBudgetTemplate.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class PrivacyBudgetTemplate

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

arn

membershipId

membershipArn

collaborationId

collaborationArn

createTime

updateTime

privacyBudgetType

privacyBudgetTypeAsString

autoRefresh

autoRefreshAsString

parameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields