CreateFacetRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.clouddirectory.model.CloudDirectoryRequest
    - - software.amazon.awssdk.services.clouddirectory.model.CreateFacetRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateFacetRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<FacetAttribute>`	`attributes()` The attributes that are associated with the Facet.
`static CreateFacetRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`FacetStyle`	`facetStyle()` There are two different styles that you can define on any given facet, `Static` and `Dynamic`.
`String`	`facetStyleAsString()` There are two different styles that you can define on any given facet, `Static` and `Dynamic`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`name()` The name of the Facet, which is unique for a given schema.
`ObjectType`	`objectType()` Specifies whether a given object created from this facet is of type node, leaf node, policy or index.
`String`	`objectTypeAsString()` Specifies whether a given object created from this facet is of type node, leaf node, policy or index.
`String`	`schemaArn()` The schema ARN in which the new Facet will be created.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateFacetRequest.Builder>`	`serializableBuilderClass()`
`CreateFacetRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

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

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

- Method Detail
  - schemaArn
```
public String schemaArn()
```
    The schema ARN in which the new Facet will be created. For more information, see arns.
    
    Returns:
    
    The schema ARN in which the new Facet will be created. For more information, see arns.
  - name
```
public String name()
```
    The name of the Facet, which is unique for a given schema.
    
    Returns:
    
    The name of the Facet, which is unique for a given schema.
  - attributes
```
public List<FacetAttribute> attributes()
```
    The attributes that are associated with the Facet.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The attributes that are associated with the Facet.
  - objectType
```
public ObjectType objectType()
```
    Specifies whether a given object created from this facet is of type node, leaf node, policy or index.
    - Node: Can have multiple children but one parent.
    - Leaf node: Cannot have children but can have multiple parents.
    - Policy: Allows you to store a policy document and policy type. For more information, see Policies.
    - Index: Can be created with the Index API.
    If the service returns an enum value that is not available in the current SDK version, objectType will return ObjectType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectTypeAsString().
    Returns:
    Specifies whether a given object created from this facet is of type node, leaf node, policy or index.
    
    Node: Can have multiple children but one parent.
    
    Leaf node: Cannot have children but can have multiple parents.
    
    Policy: Allows you to store a policy document and policy type. For more information, see Policies.
    
    Index: Can be created with the Index API.
    See Also:
    
    ObjectType
  - objectTypeAsString
```
public String objectTypeAsString()
```
    Specifies whether a given object created from this facet is of type node, leaf node, policy or index.
    - Node: Can have multiple children but one parent.
    - Leaf node: Cannot have children but can have multiple parents.
    - Policy: Allows you to store a policy document and policy type. For more information, see Policies.
    - Index: Can be created with the Index API.
    If the service returns an enum value that is not available in the current SDK version, objectType will return ObjectType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectTypeAsString().
    Returns:
    Specifies whether a given object created from this facet is of type node, leaf node, policy or index.
    
    Node: Can have multiple children but one parent.
    
    Leaf node: Cannot have children but can have multiple parents.
    
    Policy: Allows you to store a policy document and policy type. For more information, see Policies.
    
    Index: Can be created with the Index API.
    See Also:
    
    ObjectType
  - facetStyle
```
public FacetStyle facetStyle()
```
    There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.
    
    If the service returns an enum value that is not available in the current SDK version, facetStyle will return FacetStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from facetStyleAsString().
    
    Returns:
    
    There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.
    
    See Also:
    
    FacetStyle
  - facetStyleAsString
```
public String facetStyleAsString()
```
    There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.
    
    If the service returns an enum value that is not available in the current SDK version, facetStyle will return FacetStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from facetStyleAsString().
    
    Returns:
    
    There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.
    
    See Also:
    
    FacetStyle
  - toBuilder
```
public CreateFacetRequest.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<CreateFacetRequest.Builder,CreateFacetRequest>
    
    Specified by:
    
    toBuilder in class CloudDirectoryRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateFacetRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateFacetRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <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 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.

Class CreateFacetRequest

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

schemaArn

name

attributes

objectType

objectTypeAsString

facetStyle

facetStyleAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields