@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateBranchRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
The request structure for the create branch request.
NOOP
Constructor and Description |
---|
CreateBranchRequest() |
Modifier and Type | Method and Description |
---|---|
CreateBranchRequest |
addEnvironmentVariablesEntry(String key,
String value)
Add a single EnvironmentVariables entry
|
CreateBranchRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateBranchRequest |
clearEnvironmentVariablesEntries()
Removes all the entries added into EnvironmentVariables.
|
CreateBranchRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateBranchRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAppId()
The unique ID for an Amplify app.
|
Backend |
getBackend()
The backend for a
Branch of an Amplify app. |
String |
getBackendEnvironmentArn()
The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
|
String |
getBasicAuthCredentials()
The basic authorization credentials for the branch.
|
String |
getBranchName()
The name for the branch.
|
String |
getBuildSpec()
The build specification (build spec) for the branch.
|
String |
getDescription()
The description for the branch.
|
String |
getDisplayName()
The display name for a branch.
|
Boolean |
getEnableAutoBuild()
Enables auto building for the branch.
|
Boolean |
getEnableBasicAuth()
Enables basic authorization for the branch.
|
Boolean |
getEnableNotification()
Enables notifications for the branch.
|
Boolean |
getEnablePerformanceMode()
Enables performance mode for the branch.
|
Boolean |
getEnablePullRequestPreview()
Enables pull request previews for this branch.
|
Map<String,String> |
getEnvironmentVariables()
The environment variables for the branch.
|
String |
getFramework()
The framework for the branch.
|
String |
getPullRequestEnvironmentName()
The Amplify environment name for the pull request.
|
String |
getStage()
Describes the current stage for the branch.
|
Map<String,String> |
getTags()
The tag for the branch.
|
String |
getTtl()
The content Time To Live (TTL) for the website in seconds.
|
int |
hashCode() |
Boolean |
isEnableAutoBuild()
Enables auto building for the branch.
|
Boolean |
isEnableBasicAuth()
Enables basic authorization for the branch.
|
Boolean |
isEnableNotification()
Enables notifications for the branch.
|
Boolean |
isEnablePerformanceMode()
Enables performance mode for the branch.
|
Boolean |
isEnablePullRequestPreview()
Enables pull request previews for this branch.
|
void |
setAppId(String appId)
The unique ID for an Amplify app.
|
void |
setBackend(Backend backend)
The backend for a
Branch of an Amplify app. |
void |
setBackendEnvironmentArn(String backendEnvironmentArn)
The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
|
void |
setBasicAuthCredentials(String basicAuthCredentials)
The basic authorization credentials for the branch.
|
void |
setBranchName(String branchName)
The name for the branch.
|
void |
setBuildSpec(String buildSpec)
The build specification (build spec) for the branch.
|
void |
setDescription(String description)
The description for the branch.
|
void |
setDisplayName(String displayName)
The display name for a branch.
|
void |
setEnableAutoBuild(Boolean enableAutoBuild)
Enables auto building for the branch.
|
void |
setEnableBasicAuth(Boolean enableBasicAuth)
Enables basic authorization for the branch.
|
void |
setEnableNotification(Boolean enableNotification)
Enables notifications for the branch.
|
void |
setEnablePerformanceMode(Boolean enablePerformanceMode)
Enables performance mode for the branch.
|
void |
setEnablePullRequestPreview(Boolean enablePullRequestPreview)
Enables pull request previews for this branch.
|
void |
setEnvironmentVariables(Map<String,String> environmentVariables)
The environment variables for the branch.
|
void |
setFramework(String framework)
The framework for the branch.
|
void |
setPullRequestEnvironmentName(String pullRequestEnvironmentName)
The Amplify environment name for the pull request.
|
void |
setStage(String stage)
Describes the current stage for the branch.
|
void |
setTags(Map<String,String> tags)
The tag for the branch.
|
void |
setTtl(String ttl)
The content Time To Live (TTL) for the website in seconds.
|
String |
toString()
Returns a string representation of this object.
|
CreateBranchRequest |
withAppId(String appId)
The unique ID for an Amplify app.
|
CreateBranchRequest |
withBackend(Backend backend)
The backend for a
Branch of an Amplify app. |
CreateBranchRequest |
withBackendEnvironmentArn(String backendEnvironmentArn)
The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
|
CreateBranchRequest |
withBasicAuthCredentials(String basicAuthCredentials)
The basic authorization credentials for the branch.
|
CreateBranchRequest |
withBranchName(String branchName)
The name for the branch.
|
CreateBranchRequest |
withBuildSpec(String buildSpec)
The build specification (build spec) for the branch.
|
CreateBranchRequest |
withDescription(String description)
The description for the branch.
|
CreateBranchRequest |
withDisplayName(String displayName)
The display name for a branch.
|
CreateBranchRequest |
withEnableAutoBuild(Boolean enableAutoBuild)
Enables auto building for the branch.
|
CreateBranchRequest |
withEnableBasicAuth(Boolean enableBasicAuth)
Enables basic authorization for the branch.
|
CreateBranchRequest |
withEnableNotification(Boolean enableNotification)
Enables notifications for the branch.
|
CreateBranchRequest |
withEnablePerformanceMode(Boolean enablePerformanceMode)
Enables performance mode for the branch.
|
CreateBranchRequest |
withEnablePullRequestPreview(Boolean enablePullRequestPreview)
Enables pull request previews for this branch.
|
CreateBranchRequest |
withEnvironmentVariables(Map<String,String> environmentVariables)
The environment variables for the branch.
|
CreateBranchRequest |
withFramework(String framework)
The framework for the branch.
|
CreateBranchRequest |
withPullRequestEnvironmentName(String pullRequestEnvironmentName)
The Amplify environment name for the pull request.
|
CreateBranchRequest |
withStage(Stage stage)
Describes the current stage for the branch.
|
CreateBranchRequest |
withStage(String stage)
Describes the current stage for the branch.
|
CreateBranchRequest |
withTags(Map<String,String> tags)
The tag for the branch.
|
CreateBranchRequest |
withTtl(String ttl)
The content Time To Live (TTL) for the website in seconds.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setAppId(String appId)
The unique ID for an Amplify app.
appId
- The unique ID for an Amplify app.public String getAppId()
The unique ID for an Amplify app.
public CreateBranchRequest withAppId(String appId)
The unique ID for an Amplify app.
appId
- The unique ID for an Amplify app.public void setBranchName(String branchName)
The name for the branch.
branchName
- The name for the branch.public String getBranchName()
The name for the branch.
public CreateBranchRequest withBranchName(String branchName)
The name for the branch.
branchName
- The name for the branch.public void setDescription(String description)
The description for the branch.
description
- The description for the branch.public String getDescription()
The description for the branch.
public CreateBranchRequest withDescription(String description)
The description for the branch.
description
- The description for the branch.public void setStage(String stage)
Describes the current stage for the branch.
stage
- Describes the current stage for the branch.Stage
public String getStage()
Describes the current stage for the branch.
Stage
public CreateBranchRequest withStage(String stage)
Describes the current stage for the branch.
stage
- Describes the current stage for the branch.Stage
public CreateBranchRequest withStage(Stage stage)
Describes the current stage for the branch.
stage
- Describes the current stage for the branch.Stage
public void setFramework(String framework)
The framework for the branch.
framework
- The framework for the branch.public String getFramework()
The framework for the branch.
public CreateBranchRequest withFramework(String framework)
The framework for the branch.
framework
- The framework for the branch.public void setEnableNotification(Boolean enableNotification)
Enables notifications for the branch.
enableNotification
- Enables notifications for the branch.public Boolean getEnableNotification()
Enables notifications for the branch.
public CreateBranchRequest withEnableNotification(Boolean enableNotification)
Enables notifications for the branch.
enableNotification
- Enables notifications for the branch.public Boolean isEnableNotification()
Enables notifications for the branch.
public void setEnableAutoBuild(Boolean enableAutoBuild)
Enables auto building for the branch.
enableAutoBuild
- Enables auto building for the branch.public Boolean getEnableAutoBuild()
Enables auto building for the branch.
public CreateBranchRequest withEnableAutoBuild(Boolean enableAutoBuild)
Enables auto building for the branch.
enableAutoBuild
- Enables auto building for the branch.public Boolean isEnableAutoBuild()
Enables auto building for the branch.
public Map<String,String> getEnvironmentVariables()
The environment variables for the branch.
public void setEnvironmentVariables(Map<String,String> environmentVariables)
The environment variables for the branch.
environmentVariables
- The environment variables for the branch.public CreateBranchRequest withEnvironmentVariables(Map<String,String> environmentVariables)
The environment variables for the branch.
environmentVariables
- The environment variables for the branch.public CreateBranchRequest addEnvironmentVariablesEntry(String key, String value)
public CreateBranchRequest clearEnvironmentVariablesEntries()
public void setBasicAuthCredentials(String basicAuthCredentials)
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and
provide them in the format user:password
.
basicAuthCredentials
- The basic authorization credentials for the branch. You must base64-encode the authorization credentials
and provide them in the format user:password
.public String getBasicAuthCredentials()
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and
provide them in the format user:password
.
user:password
.public CreateBranchRequest withBasicAuthCredentials(String basicAuthCredentials)
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and
provide them in the format user:password
.
basicAuthCredentials
- The basic authorization credentials for the branch. You must base64-encode the authorization credentials
and provide them in the format user:password
.public void setEnableBasicAuth(Boolean enableBasicAuth)
Enables basic authorization for the branch.
enableBasicAuth
- Enables basic authorization for the branch.public Boolean getEnableBasicAuth()
Enables basic authorization for the branch.
public CreateBranchRequest withEnableBasicAuth(Boolean enableBasicAuth)
Enables basic authorization for the branch.
enableBasicAuth
- Enables basic authorization for the branch.public Boolean isEnableBasicAuth()
Enables basic authorization for the branch.
public void setEnablePerformanceMode(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.
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.
public Boolean getEnablePerformanceMode()
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.
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.
public CreateBranchRequest withEnablePerformanceMode(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.
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.
public Boolean isEnablePerformanceMode()
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.
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.
public Map<String,String> getTags()
The tag for the branch.
public void setTags(Map<String,String> tags)
The tag for the branch.
tags
- The tag for the branch.public CreateBranchRequest withTags(Map<String,String> tags)
The tag for the branch.
tags
- The tag for the branch.public CreateBranchRequest addTagsEntry(String key, String value)
public CreateBranchRequest clearTagsEntries()
public void setBuildSpec(String buildSpec)
The build specification (build spec) for the branch.
buildSpec
- The build specification (build spec) for the branch.public String getBuildSpec()
The build specification (build spec) for the branch.
public CreateBranchRequest withBuildSpec(String buildSpec)
The build specification (build spec) for the branch.
buildSpec
- The build specification (build spec) for the branch.public void setTtl(String ttl)
The content Time To Live (TTL) for the website in seconds.
ttl
- The content Time To Live (TTL) for the website in seconds.public String getTtl()
The content Time To Live (TTL) for the website in seconds.
public CreateBranchRequest withTtl(String ttl)
The content Time To Live (TTL) for the website in seconds.
ttl
- The content Time To Live (TTL) for the website in seconds.public void setDisplayName(String displayName)
The display name for a branch. This is used as the default domain prefix.
displayName
- The display name for a branch. This is used as the default domain prefix.public String getDisplayName()
The display name for a branch. This is used as the default domain prefix.
public CreateBranchRequest withDisplayName(String displayName)
The display name for a branch. This is used as the default domain prefix.
displayName
- The display name for a branch. This is used as the default domain prefix.public void setEnablePullRequestPreview(Boolean enablePullRequestPreview)
Enables pull request previews for this branch.
enablePullRequestPreview
- Enables pull request previews for this branch.public Boolean getEnablePullRequestPreview()
Enables pull request previews for this branch.
public CreateBranchRequest withEnablePullRequestPreview(Boolean enablePullRequestPreview)
Enables pull request previews for this branch.
enablePullRequestPreview
- Enables pull request previews for this branch.public Boolean isEnablePullRequestPreview()
Enables pull request previews for this branch.
public void setPullRequestEnvironmentName(String pullRequestEnvironmentName)
The Amplify environment name for the pull request.
pullRequestEnvironmentName
- The Amplify environment name for the pull request.public String getPullRequestEnvironmentName()
The Amplify environment name for the pull request.
public CreateBranchRequest withPullRequestEnvironmentName(String pullRequestEnvironmentName)
The Amplify environment name for the pull request.
pullRequestEnvironmentName
- The Amplify environment name for the pull request.public void setBackendEnvironmentArn(String backendEnvironmentArn)
The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
backendEnvironmentArn
- The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
public String getBackendEnvironmentArn()
The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
public CreateBranchRequest withBackendEnvironmentArn(String backendEnvironmentArn)
The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
backendEnvironmentArn
- The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
public void setBackend(Backend backend)
The backend for a Branch
of an Amplify app. Use for a backend created from an CloudFormation stack.
This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
backend
- The backend for a Branch
of an Amplify app. Use for a backend created from an CloudFormation
stack.
This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
public Backend getBackend()
The backend for a Branch
of an Amplify app. Use for a backend created from an CloudFormation stack.
This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
Branch
of an Amplify app. Use for a backend created from an CloudFormation
stack.
This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
public CreateBranchRequest withBackend(Backend backend)
The backend for a Branch
of an Amplify app. Use for a backend created from an CloudFormation stack.
This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
backend
- The backend for a Branch
of an Amplify app. Use for a backend created from an CloudFormation
stack.
This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
public String toString()
toString
in class Object
Object.toString()
public CreateBranchRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()