software.amazon.awssdk.services.codepipeline.model

Class CreateCustomActionTypeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codepipeline.model.CodePipelineRequest

software.amazon.awssdk.services.codepipeline.model.CreateCustomActionTypeRequest

All Implemented Interfaces:

ToCopyableBuilder<CreateCustomActionTypeRequest.Builder,CreateCustomActionTypeRequest>

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

Represents the input of a CreateCustomActionType operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateCustomActionTypeRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateCustomActionTypeRequest.Builder	builder()
ActionCategory	category() The category of the custom action, such as a build action or a test action.
String	categoryAsString() The category of the custom action, such as a build action or a test action.
List<ActionConfigurationProperty>	configurationProperties() The configuration properties for the custom action.
boolean	equals(Object obj)
<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()
ArtifactDetails	inputArtifactDetails() The details of the input artifact for the action, such as its commit ID.
ArtifactDetails	outputArtifactDetails() The details of the output artifact of the action, such as its commit ID.
String	provider() The provider of the service used in the custom action, such as AWS CodeDeploy.
static Class<? extends CreateCustomActionTypeRequest.Builder>	serializableBuilderClass()
ActionTypeSettings	settings() Returns information about the settings for an action type.
CreateCustomActionTypeRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	version() The version identifier of the custom action.

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

requestOverrideConfig

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

category

public ActionCategory category()

The category of the custom action, such as a build action or a test action.

Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.

If the service returns an enum value that is not available in the current SDK version, category will return ActionCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from categoryAsString().

Returns:

The category of the custom action, such as a build action or a test action.

Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.

See Also:

ActionCategory

categoryAsString

public String categoryAsString()

The category of the custom action, such as a build action or a test action.

Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.

If the service returns an enum value that is not available in the current SDK version, category will return ActionCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from categoryAsString().

Returns:

The category of the custom action, such as a build action or a test action.

Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.

See Also:

ActionCategory

provider

public String provider()

The provider of the service used in the custom action, such as AWS CodeDeploy.

Returns:

The provider of the service used in the custom action, such as AWS CodeDeploy.

version

public String version()

The version identifier of the custom action.

Returns:

The version identifier of the custom action.

settings

public ActionTypeSettings settings()

Returns information about the settings for an action type.

Returns:

Returns information about the settings for an action type.

configurationProperties

public List<ActionConfigurationProperty> configurationProperties()

The configuration properties for the custom action.

You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The configuration properties for the custom action.

You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.

inputArtifactDetails

public ArtifactDetails inputArtifactDetails()

The details of the input artifact for the action, such as its commit ID.

Returns:

The details of the input artifact for the action, such as its commit ID.

outputArtifactDetails

public ArtifactDetails outputArtifactDetails()

The details of the output artifact of the action, such as its commit ID.

Returns:

The details of the output artifact of the action, such as its commit ID.

toBuilder

public CreateCustomActionTypeRequest.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<CreateCustomActionTypeRequest.Builder,CreateCustomActionTypeRequest>

Specified by:

toBuilder in class CodePipelineRequest

Returns:

a builder for type T

builder

public static CreateCustomActionTypeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateCustomActionTypeRequest.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