software.amazon.awssdk.services.amplify.model

Class AutoBranchCreationConfig

java.lang.Object

software.amazon.awssdk.services.amplify.model.AutoBranchCreationConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AutoBranchCreationConfig.Builder,AutoBranchCreationConfig>

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

Describes the automated branch creation configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AutoBranchCreationConfig.Builder

Method Summary

Modifier and Type	Method and Description
String	basicAuthCredentials() The basic authorization credentials for the autocreated branch.
static AutoBranchCreationConfig.Builder	builder()
String	buildSpec() The build specification (build spec) for the autocreated branch.
Boolean	enableAutoBuild() Enables auto building for the autocreated branch.
Boolean	enableBasicAuth() Enables basic authorization for the autocreated branch.
Boolean	enablePerformanceMode() Enables performance mode for the branch.
Boolean	enablePullRequestPreview() Enables pull request previews for the autocreated branch.
Map<String,String>	environmentVariables() The environment variables for the autocreated branch.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	framework() The framework for the autocreated branch.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEnvironmentVariables() For responses, this returns true if the service returned a value for the EnvironmentVariables property.
int	hashCode()
String	pullRequestEnvironmentName() The Amplify environment name for the pull request.
List<SdkField<?>>	sdkFields()
static Class<? extends AutoBranchCreationConfig.Builder>	serializableBuilderClass()
Stage	stage() Describes the current stage for the autocreated branch.
String	stageAsString() Describes the current stage for the autocreated branch.
AutoBranchCreationConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

stage

public final Stage stage()

Describes the current stage for the autocreated branch.

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

Returns:

Describes the current stage for the autocreated branch.

See Also:

Stage

stageAsString

public final String stageAsString()

Describes the current stage for the autocreated branch.

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

Returns:

Describes the current stage for the autocreated branch.

See Also:

Stage

framework

public final String framework()

The framework for the autocreated branch.

Returns:

The framework for the autocreated branch.

enableAutoBuild

public final Boolean enableAutoBuild()

Enables auto building for the autocreated branch.

Returns:

Enables auto building for the autocreated branch.

hasEnvironmentVariables

public final boolean hasEnvironmentVariables()

For responses, this returns true if the service returned a value for the EnvironmentVariables 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.

environmentVariables

public final Map<String,String> environmentVariables()

The environment variables for the autocreated branch.

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 hasEnvironmentVariables() method.

Returns:

The environment variables for the autocreated branch.

basicAuthCredentials

public final String basicAuthCredentials()

The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password.

Returns:

The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password.

enableBasicAuth

public final Boolean enableBasicAuth()

Enables basic authorization for the autocreated branch.

Returns:

Enables basic authorization for the autocreated branch.

enablePerformanceMode

public final Boolean enablePerformanceMode()

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

Returns:

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

buildSpec

public final String buildSpec()

The build specification (build spec) for the autocreated branch.

Returns:

The build specification (build spec) for the autocreated branch.

enablePullRequestPreview

public final Boolean enablePullRequestPreview()

Enables pull request previews for the autocreated branch.

Returns:

Enables pull request previews for the autocreated branch.

pullRequestEnvironmentName

public final String pullRequestEnvironmentName()

The Amplify environment name for the pull request.

Returns:

The Amplify environment name for the pull request.

toBuilder

public AutoBranchCreationConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AutoBranchCreationConfig.Builder,AutoBranchCreationConfig>

builder

public static AutoBranchCreationConfig.Builder builder()

serializableBuilderClass

public static Class<? extends AutoBranchCreationConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo