ActionConfigurationProperty (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.codepipeline.model.ActionConfigurationProperty

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<ActionConfigurationProperty.Builder,ActionConfigurationProperty>

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

Represents information about an action configuration property.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ActionConfigurationProperty.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ActionConfigurationProperty.Builder`	`builder()`
`String`	`description()` The description of the action configuration property that will be displayed to users.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`key()` Whether the configuration property is a key.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`String`	`name()` The name of the action configuration property.
`Boolean`	`queryable()` Indicates that the property will be used in conjunction with PollForJobs.
`Boolean`	`required()` Whether the configuration property is a required value.
`Boolean`	`secret()` Whether the configuration property is secret.
`static Class<? extends ActionConfigurationProperty.Builder>`	`serializableBuilderClass()`
`ActionConfigurationProperty.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`ActionConfigurationPropertyType`	`type()` The type of the configuration property.
`String`	`typeAsString()` The type of the configuration property.

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
  - name
```
public String name()
```
    The name of the action configuration property.
    
    Returns:
    
    The name of the action configuration property.
  - required
```
public Boolean required()
```
    Whether the configuration property is a required value.
    
    Returns:
    
    Whether the configuration property is a required value.
  - key
```
public Boolean key()
```
    Whether the configuration property is a key.
    
    Returns:
    
    Whether the configuration property is a key.
  - secret
```
public Boolean secret()
```
    Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
    
    When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.
    
    Returns:
    
    Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
    
    When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.
  - queryable
```
public Boolean queryable()
```
    Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.
    
    If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
    
    Returns:
    
    Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.
    
    If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
  - description
```
public String description()
```
    The description of the action configuration property that will be displayed to users.
    
    Returns:
    
    The description of the action configuration property that will be displayed to users.
  - type
```
public ActionConfigurationPropertyType type()
```
    The type of the configuration property.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ActionConfigurationPropertyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the configuration property.
    
    See Also:
    
    ActionConfigurationPropertyType
  - typeAsString
```
public String typeAsString()
```
    The type of the configuration property.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ActionConfigurationPropertyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the configuration property.
    
    See Also:
    
    ActionConfigurationPropertyType
  - toBuilder
```
public ActionConfigurationProperty.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<ActionConfigurationProperty.Builder,ActionConfigurationProperty>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ActionConfigurationProperty.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ActionConfigurationProperty.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)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class ActionConfigurationProperty

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

required

key

secret

queryable

description

type

typeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall