java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.accessanalyzer.model.AccessAnalyzerRequest
    - - software.amazon.awssdk.services.accessanalyzer.model.CreateAnalyzerRequest

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

@Generated("software.amazon.awssdk:codegen")
public final class CreateAnalyzerRequest
extends AccessAnalyzerRequest
implements ToCopyableBuilder<CreateAnalyzerRequest.Builder,CreateAnalyzerRequest>

Creates an analyzer.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateAnalyzerRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`analyzerName()`	The name of the analyzer to create.
`List<InlineArchiveRule>`	`archiveRules()`	Specifies the archive rules to add for the analyzer.
`static CreateAnalyzerRequest.Builder`	`builder()`
`String`	`clientToken()`	A client token.
`AnalyzerConfiguration`	`configuration()`	Specifies the configuration of the analyzer.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasArchiveRules()`	For responses, this returns true if the service returned a value for the ArchiveRules property.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateAnalyzerRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`	An array of key-value pairs to apply to the analyzer.
`CreateAnalyzerRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Type`	`type()`	The type of analyzer to create.
`String`	`typeAsString()`	The type of analyzer to create.

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
  - analyzerName
```
public final String analyzerName()
```
    The name of the analyzer to create.
    
    Returns:
    
    The name of the analyzer to create.
  - type
```
public final Type type()
```
    The type of analyzer to create. Only ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS, and ORGANIZTAION_UNUSED_ACCESS analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.
    
    If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of analyzer to create. Only ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS, and ORGANIZTAION_UNUSED_ACCESS analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.
    
    See Also:
    
    Type
  - typeAsString
```
public final String typeAsString()
```
    The type of analyzer to create. Only ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS, and ORGANIZTAION_UNUSED_ACCESS analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.
    
    If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of analyzer to create. Only ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS, and ORGANIZTAION_UNUSED_ACCESS analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.
    
    See Also:
    
    Type
  - hasArchiveRules
```
public final boolean hasArchiveRules()
```
    For responses, this returns true if the service returned a value for the ArchiveRules 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.
  - archiveRules
```
public final List<InlineArchiveRule> archiveRules()
```
    Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.
    
    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 hasArchiveRules() method.
    
    Returns:
    
    Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.
  - 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 array of key-value pairs to apply to the analyzer.
    
    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 array of key-value pairs to apply to the analyzer.
  - clientToken
```
public final String clientToken()
```
    A client token.
    
    Returns:
    
    A client token.
  - configuration
```
public final AnalyzerConfiguration configuration()
```
    Specifies the configuration of the analyzer. If the analyzer is an unused access analyzer, the specified scope of unused access is used for the configuration. If the analyzer is an external access analyzer, this field is not used.
    
    Returns:
    
    Specifies the configuration of the analyzer. If the analyzer is an unused access analyzer, the specified scope of unused access is used for the configuration. If the analyzer is an external access analyzer, this field is not used.
  - toBuilder
```
public CreateAnalyzerRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateAnalyzerRequest.Builder,CreateAnalyzerRequest>
    
    Specified by:
    
    toBuilder in class AccessAnalyzerRequest
  - builder
```
public static CreateAnalyzerRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateAnalyzerRequest.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 CreateAnalyzerRequest

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

analyzerName

type

typeAsString

hasArchiveRules

archiveRules

hasTags

tags

clientToken

configuration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields