software.amazon.awssdk.services.amplify.model

Class CreateBranchRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.amplify.model.AmplifyRequest

software.amazon.awssdk.services.amplify.model.CreateBranchRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateBranchRequest.Builder,CreateBranchRequest>

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

The request structure for the create branch request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateBranchRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	appId() The unique ID for an Amplify app.
String	backendEnvironmentArn() The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
String	basicAuthCredentials() The basic authorization credentials for the branch.
String	branchName() The name for the branch.
static CreateBranchRequest.Builder	builder()
String	buildSpec() The build specification (build spec) for the branch.
String	description() The description for the branch.
String	displayName() The display name for a branch.
Boolean	enableAutoBuild() Enables auto building for the branch.
Boolean	enableBasicAuth() Enables basic authorization for the branch.
Boolean	enableNotification() Enables notifications for the branch.
Boolean	enablePerformanceMode() Enables performance mode for the branch.
Boolean	enablePullRequestPreview() Enables pull request previews for this branch.
Map<String,String>	environmentVariables() The environment variables for the branch.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	framework() The framework for the 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()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	pullRequestEnvironmentName() The Amplify environment name for the pull request.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBranchRequest.Builder>	serializableBuilderClass()
Stage	stage() Describes the current stage for the branch.
String	stageAsString() Describes the current stage for the branch.
Map<String,String>	tags() The tag for the branch.
CreateBranchRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	ttl() The content Time To Live (TTL) for the website in seconds.

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

appId

public final String appId()

The unique ID for an Amplify app.

Returns:

The unique ID for an Amplify app.

branchName

public final String branchName()

The name for the branch.

Returns:

The name for the branch.

description

public final String description()

The description for the branch.

Returns:

The description for the branch.

stage

public final Stage stage()

Describes the current stage for the 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 branch.

See Also:

Stage

stageAsString

public final String stageAsString()

Describes the current stage for the 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 branch.

See Also:

Stage

framework

public final String framework()

The framework for the branch.

Returns:

The framework for the branch.

enableNotification

public final Boolean enableNotification()

Enables notifications for the branch.

Returns:

Enables notifications for the branch.

enableAutoBuild

public final Boolean enableAutoBuild()

Enables auto building for the branch.

Returns:

Enables auto building for the 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 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 branch.

basicAuthCredentials

public final String basicAuthCredentials()

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

Returns:

The basic authorization credentials for the 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 branch.

Returns:

Enables basic authorization for the 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.

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()

The tag for the 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 hasTags() method.

Returns:

The tag for the branch.

buildSpec

public final String buildSpec()

The build specification (build spec) for the branch.

Returns:

The build specification (build spec) for the branch.

ttl

public final String ttl()

The content Time To Live (TTL) for the website in seconds.

Returns:

The content Time To Live (TTL) for the website in seconds.

displayName

public final String displayName()

The display name for a branch. This is used as the default domain prefix.

Returns:

The display name for a branch. This is used as the default domain prefix.

enablePullRequestPreview

public final Boolean enablePullRequestPreview()

Enables pull request previews for this branch.

Returns:

Enables pull request previews for this branch.

pullRequestEnvironmentName

public final String pullRequestEnvironmentName()

The Amplify environment name for the pull request.

Returns:

The Amplify environment name for the pull request.

backendEnvironmentArn

public final String backendEnvironmentArn()

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

Returns:

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

toBuilder

public CreateBranchRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBranchRequest.Builder,CreateBranchRequest>

Specified by:

toBuilder in class AmplifyRequest

builder

public static CreateBranchRequest.Builder builder()

serializableBuilderClass

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