PutProfileObjectTypeRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesRequest
    - - software.amazon.awssdk.services.customerprofiles.model.PutProfileObjectTypeRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<PutProfileObjectTypeRequest.Builder,PutProfileObjectTypeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutProfileObjectTypeRequest
extends CustomerProfilesRequest
implements ToCopyableBuilder<PutProfileObjectTypeRequest.Builder,PutProfileObjectTypeRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutProfileObjectTypeRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PutProfileObjectTypeRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`allowProfileCreation()` Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.
`static PutProfileObjectTypeRequest.Builder`	`builder()`
`String`	`description()` Description of the profile object type.
`String`	`domainName()` The unique name of the domain.
`String`	`encryptionKey()` The customer-provided key to encrypt the profile object that will be created in this profile object type.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Integer`	`expirationDays()` The number of days until the data in the object expires.
`Map<String,ObjectTypeField>`	`fields()` A map of the name and ObjectType field.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFields()` For responses, this returns true if the service returned a value for the Fields property.
`int`	`hashCode()`
`boolean`	`hasKeys()` For responses, this returns true if the service returned a value for the Keys property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`Map<String,List<ObjectTypeKey>>`	`keys()` A list of unique keys that can be used to map data to the profile.
`String`	`objectTypeName()` The name of the profile object type.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutProfileObjectTypeRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceLastUpdatedTimestampFormat()` The format of your `sourceLastUpdatedTimestamp` that was previously set up.
`Map<String,String>`	`tags()` The tags used to organize, track, or control access for this resource.
`String`	`templateId()` A unique identifier for the object template.
`PutProfileObjectTypeRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - domainName
```
public final String domainName()
```
    The unique name of the domain.
    
    Returns:
    
    The unique name of the domain.
  - objectTypeName
```
public final String objectTypeName()
```
    The name of the profile object type.
    
    Returns:
    
    The name of the profile object type.
  - description
```
public final String description()
```
    Description of the profile object type.
    
    Returns:
    
    Description of the profile object type.
  - templateId
```
public final String templateId()
```
    A unique identifier for the object template. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a BadRequestException. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a BadRequestException.
    
    Returns:
    
    A unique identifier for the object template. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a BadRequestException. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a BadRequestException.
  - expirationDays
```
public final Integer expirationDays()
```
    The number of days until the data in the object expires.
    
    Returns:
    
    The number of days until the data in the object expires.
  - encryptionKey
```
public final String encryptionKey()
```
    The customer-provided key to encrypt the profile object that will be created in this profile object type.
    
    Returns:
    
    The customer-provided key to encrypt the profile object that will be created in this profile object type.
  - allowProfileCreation
```
public final Boolean allowProfileCreation()
```
    Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.
    
    Returns:
    
    Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.
  - sourceLastUpdatedTimestampFormat
```
public final String sourceLastUpdatedTimestampFormat()
```
    The format of your sourceLastUpdatedTimestamp that was previously set up.
    
    Returns:
    
    The format of your sourceLastUpdatedTimestamp that was previously set up.
  - hasFields
```
public final boolean hasFields()
```
    For responses, this returns true if the service returned a value for the Fields 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.
  - fields
```
public final Map<String,ObjectTypeField> fields()
```
    A map of the name and ObjectType field.
    
    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 hasFields() method.
    
    Returns:
    
    A map of the name and ObjectType field.
  - hasKeys
```
public final boolean hasKeys()
```
    For responses, this returns true if the service returned a value for the Keys 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.
  - keys
```
public final Map<String,List<ObjectTypeKey>> keys()
```
    A list of unique keys that can be used to map data to the 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 hasKeys() method.
    
    Returns:
    
    A list of unique keys that can be used to map data to 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 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()
```
    The tags used to organize, track, or control access for 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:
    
    The tags used to organize, track, or control access for this resource.
  - toBuilder
```
public PutProfileObjectTypeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutProfileObjectTypeRequest.Builder,PutProfileObjectTypeRequest>
    
    Specified by:
    
    toBuilder in class CustomerProfilesRequest
  - builder
```
public static PutProfileObjectTypeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutProfileObjectTypeRequest.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)
```
    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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PutProfileObjectTypeRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

domainName

objectTypeName

description

templateId

expirationDays

encryptionKey

allowProfileCreation

sourceLastUpdatedTimestampFormat

hasFields

fields

hasKeys

keys

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields