CreateBranchRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.amplify.model.CreateBranchRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateBranchRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Request structure for a branch create request.

See Also:

AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateBranchRequest()

Constructors
Constructor and Description
`CreateBranchRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateBranchRequest`	`addEnvironmentVariablesEntry(String key, String value)`
`CreateBranchRequest`	`addTagsEntry(String key, String value)`
`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()` Unique Id for an Amplify App.
`String`	`getBackendEnvironmentArn()` ARN for a Backend Environment, part of an Amplify App.
`String`	`getBasicAuthCredentials()` Basic Authorization credentials for the branch.
`String`	`getBranchName()` Name for the branch.
`String`	`getBuildSpec()` BuildSpec for the branch.
`String`	`getDescription()` Description for the branch.
`String`	`getDisplayName()` Display name for a branch, will use as the default domain prefix.
`Boolean`	`getEnableAutoBuild()` Enables auto building for the branch.
`Boolean`	`getEnableBasicAuth()` Enables Basic Auth for the branch.
`Boolean`	`getEnableNotification()` Enables notifications for the branch.
`Boolean`	`getEnablePullRequestPreview()` Enables Pull Request Preview for this branch.
`Map<String,String>`	`getEnvironmentVariables()` Environment Variables for the branch.
`String`	`getFramework()` Framework for the branch.
`String`	`getPullRequestEnvironmentName()` The Amplify Environment name for the pull request.
`String`	`getStage()` Stage for the branch.
`Map<String,String>`	`getTags()` Tag for the branch.
`String`	`getTtl()` The content TTL for the website in seconds.
`int`	`hashCode()`
`Boolean`	`isEnableAutoBuild()` Enables auto building for the branch.
`Boolean`	`isEnableBasicAuth()` Enables Basic Auth for the branch.
`Boolean`	`isEnableNotification()` Enables notifications for the branch.
`Boolean`	`isEnablePullRequestPreview()` Enables Pull Request Preview for this branch.
`void`	`setAppId(String appId)` Unique Id for an Amplify App.
`void`	`setBackendEnvironmentArn(String backendEnvironmentArn)` ARN for a Backend Environment, part of an Amplify App.
`void`	`setBasicAuthCredentials(String basicAuthCredentials)` Basic Authorization credentials for the branch.
`void`	`setBranchName(String branchName)` Name for the branch.
`void`	`setBuildSpec(String buildSpec)` BuildSpec for the branch.
`void`	`setDescription(String description)` Description for the branch.
`void`	`setDisplayName(String displayName)` Display name for a branch, will use as the default domain prefix.
`void`	`setEnableAutoBuild(Boolean enableAutoBuild)` Enables auto building for the branch.
`void`	`setEnableBasicAuth(Boolean enableBasicAuth)` Enables Basic Auth for the branch.
`void`	`setEnableNotification(Boolean enableNotification)` Enables notifications for the branch.
`void`	`setEnablePullRequestPreview(Boolean enablePullRequestPreview)` Enables Pull Request Preview for this branch.
`void`	`setEnvironmentVariables(Map<String,String> environmentVariables)` Environment Variables for the branch.
`void`	`setFramework(String framework)` Framework for the branch.
`void`	`setPullRequestEnvironmentName(String pullRequestEnvironmentName)` The Amplify Environment name for the pull request.
`void`	`setStage(String stage)` Stage for the branch.
`void`	`setTags(Map<String,String> tags)` Tag for the branch.
`void`	`setTtl(String ttl)` The content TTL for the website in seconds.
`String`	`toString()` Returns a string representation of this object.
`CreateBranchRequest`	`withAppId(String appId)` Unique Id for an Amplify App.
`CreateBranchRequest`	`withBackendEnvironmentArn(String backendEnvironmentArn)` ARN for a Backend Environment, part of an Amplify App.
`CreateBranchRequest`	`withBasicAuthCredentials(String basicAuthCredentials)` Basic Authorization credentials for the branch.
`CreateBranchRequest`	`withBranchName(String branchName)` Name for the branch.
`CreateBranchRequest`	`withBuildSpec(String buildSpec)` BuildSpec for the branch.
`CreateBranchRequest`	`withDescription(String description)` Description for the branch.
`CreateBranchRequest`	`withDisplayName(String displayName)` Display name for a branch, will use as the default domain prefix.
`CreateBranchRequest`	`withEnableAutoBuild(Boolean enableAutoBuild)` Enables auto building for the branch.
`CreateBranchRequest`	`withEnableBasicAuth(Boolean enableBasicAuth)` Enables Basic Auth for the branch.
`CreateBranchRequest`	`withEnableNotification(Boolean enableNotification)` Enables notifications for the branch.
`CreateBranchRequest`	`withEnablePullRequestPreview(Boolean enablePullRequestPreview)` Enables Pull Request Preview for this branch.
`CreateBranchRequest`	`withEnvironmentVariables(Map<String,String> environmentVariables)` Environment Variables for the branch.
`CreateBranchRequest`	`withFramework(String framework)` Framework for the branch.
`CreateBranchRequest`	`withPullRequestEnvironmentName(String pullRequestEnvironmentName)` The Amplify Environment name for the pull request.
`CreateBranchRequest`	`withStage(Stage stage)` Stage for the branch.
`CreateBranchRequest`	`withStage(String stage)` Stage for the branch.
`CreateBranchRequest`	`withTags(Map<String,String> tags)` Tag for the branch.
`CreateBranchRequest`	`withTtl(String ttl)` The content TTL for the website in seconds.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateBranchRequest
```
public CreateBranchRequest()
```
- Method Detail
  - setAppId
```
public void setAppId(String appId)
```
    Unique Id for an Amplify App.
    
    Parameters:
    
    appId - Unique Id for an Amplify App.
  - getAppId
```
public String getAppId()
```
    Unique Id for an Amplify App.
    
    Returns:
    
    Unique Id for an Amplify App.
  - withAppId
```
public CreateBranchRequest withAppId(String appId)
```
    Unique Id for an Amplify App.
    
    Parameters:
    
    appId - Unique Id for an Amplify App.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBranchName
```
public void setBranchName(String branchName)
```
    Name for the branch.
    
    Parameters:
    
    branchName - Name for the branch.
  - getBranchName
```
public String getBranchName()
```
    Name for the branch.
    
    Returns:
    
    Name for the branch.
  - withBranchName
```
public CreateBranchRequest withBranchName(String branchName)
```
    Name for the branch.
    
    Parameters:
    
    branchName - Name for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    Description for the branch.
    
    Parameters:
    
    description - Description for the branch.
  - getDescription
```
public String getDescription()
```
    Description for the branch.
    
    Returns:
    
    Description for the branch.
  - withDescription
```
public CreateBranchRequest withDescription(String description)
```
    Description for the branch.
    
    Parameters:
    
    description - Description for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStage
```
public void setStage(String stage)
```
    Stage for the branch.
    
    Parameters:
    
    stage - Stage for the branch.
    
    See Also:
    
    Stage
  - getStage
```
public String getStage()
```
    Stage for the branch.
    
    Returns:
    
    Stage for the branch.
    
    See Also:
    
    Stage
  - withStage
```
public CreateBranchRequest withStage(String stage)
```
    Stage for the branch.
    
    Parameters:
    
    stage - Stage for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Stage
  - withStage
```
public CreateBranchRequest withStage(Stage stage)
```
    Stage for the branch.
    
    Parameters:
    
    stage - Stage for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Stage
  - setFramework
```
public void setFramework(String framework)
```
    Framework for the branch.
    
    Parameters:
    
    framework - Framework for the branch.
  - getFramework
```
public String getFramework()
```
    Framework for the branch.
    
    Returns:
    
    Framework for the branch.
  - withFramework
```
public CreateBranchRequest withFramework(String framework)
```
    Framework for the branch.
    
    Parameters:
    
    framework - Framework for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnableNotification
```
public void setEnableNotification(Boolean enableNotification)
```
    Enables notifications for the branch.
    
    Parameters:
    
    enableNotification - Enables notifications for the branch.
  - getEnableNotification
```
public Boolean getEnableNotification()
```
    Enables notifications for the branch.
    
    Returns:
    
    Enables notifications for the branch.
  - withEnableNotification
```
public CreateBranchRequest withEnableNotification(Boolean enableNotification)
```
    Enables notifications for the branch.
    
    Parameters:
    
    enableNotification - Enables notifications for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableNotification
```
public Boolean isEnableNotification()
```
    Enables notifications for the branch.
    
    Returns:
    
    Enables notifications for the branch.
  - setEnableAutoBuild
```
public void setEnableAutoBuild(Boolean enableAutoBuild)
```
    Enables auto building for the branch.
    
    Parameters:
    
    enableAutoBuild - Enables auto building for the branch.
  - getEnableAutoBuild
```
public Boolean getEnableAutoBuild()
```
    Enables auto building for the branch.
    
    Returns:
    
    Enables auto building for the branch.
  - withEnableAutoBuild
```
public CreateBranchRequest withEnableAutoBuild(Boolean enableAutoBuild)
```
    Enables auto building for the branch.
    
    Parameters:
    
    enableAutoBuild - Enables auto building for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableAutoBuild
```
public Boolean isEnableAutoBuild()
```
    Enables auto building for the branch.
    
    Returns:
    
    Enables auto building for the branch.
  - getEnvironmentVariables
```
public Map<String,String> getEnvironmentVariables()
```
    Environment Variables for the branch.
    
    Returns:
    
    Environment Variables for the branch.
  - setEnvironmentVariables
```
public void setEnvironmentVariables(Map<String,String> environmentVariables)
```
    Environment Variables for the branch.
    
    Parameters:
    
    environmentVariables - Environment Variables for the branch.
  - withEnvironmentVariables
```
public CreateBranchRequest withEnvironmentVariables(Map<String,String> environmentVariables)
```
    Environment Variables for the branch.
    
    Parameters:
    
    environmentVariables - Environment Variables for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addEnvironmentVariablesEntry
```
public CreateBranchRequest addEnvironmentVariablesEntry(String key,
                                                        String value)
```
  - clearEnvironmentVariablesEntries
```
public CreateBranchRequest clearEnvironmentVariablesEntries()
```
    Removes all the entries added into EnvironmentVariables.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBasicAuthCredentials
```
public void setBasicAuthCredentials(String basicAuthCredentials)
```
    Basic Authorization credentials for the branch.
    
    Parameters:
    
    basicAuthCredentials - Basic Authorization credentials for the branch.
  - getBasicAuthCredentials
```
public String getBasicAuthCredentials()
```
    Basic Authorization credentials for the branch.
    
    Returns:
    
    Basic Authorization credentials for the branch.
  - withBasicAuthCredentials
```
public CreateBranchRequest withBasicAuthCredentials(String basicAuthCredentials)
```
    Basic Authorization credentials for the branch.
    
    Parameters:
    
    basicAuthCredentials - Basic Authorization credentials for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnableBasicAuth
```
public void setEnableBasicAuth(Boolean enableBasicAuth)
```
    Enables Basic Auth for the branch.
    
    Parameters:
    
    enableBasicAuth - Enables Basic Auth for the branch.
  - getEnableBasicAuth
```
public Boolean getEnableBasicAuth()
```
    Enables Basic Auth for the branch.
    
    Returns:
    
    Enables Basic Auth for the branch.
  - withEnableBasicAuth
```
public CreateBranchRequest withEnableBasicAuth(Boolean enableBasicAuth)
```
    Enables Basic Auth for the branch.
    
    Parameters:
    
    enableBasicAuth - Enables Basic Auth for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableBasicAuth
```
public Boolean isEnableBasicAuth()
```
    Enables Basic Auth for the branch.
    
    Returns:
    
    Enables Basic Auth for the branch.
  - getTags
```
public Map<String,String> getTags()
```
    Tag for the branch.
    
    Returns:
    
    Tag for the branch.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Tag for the branch.
    
    Parameters:
    
    tags - Tag for the branch.
  - withTags
```
public CreateBranchRequest withTags(Map<String,String> tags)
```
    Tag for the branch.
    
    Parameters:
    
    tags - Tag for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateBranchRequest addTagsEntry(String key,
                                        String value)
```
  - clearTagsEntries
```
public CreateBranchRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBuildSpec
```
public void setBuildSpec(String buildSpec)
```
    BuildSpec for the branch.
    
    Parameters:
    
    buildSpec - BuildSpec for the branch.
  - getBuildSpec
```
public String getBuildSpec()
```
    BuildSpec for the branch.
    
    Returns:
    
    BuildSpec for the branch.
  - withBuildSpec
```
public CreateBranchRequest withBuildSpec(String buildSpec)
```
    BuildSpec for the branch.
    
    Parameters:
    
    buildSpec - BuildSpec for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTtl
```
public void setTtl(String ttl)
```
    The content TTL for the website in seconds.
    
    Parameters:
    
    ttl - The content TTL for the website in seconds.
  - getTtl
```
public String getTtl()
```
    The content TTL for the website in seconds.
    
    Returns:
    
    The content TTL for the website in seconds.
  - withTtl
```
public CreateBranchRequest withTtl(String ttl)
```
    The content TTL for the website in seconds.
    
    Parameters:
    
    ttl - The content TTL for the website in seconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Display name for a branch, will use as the default domain prefix.
    
    Parameters:
    
    displayName - Display name for a branch, will use as the default domain prefix.
  - getDisplayName
```
public String getDisplayName()
```
    Display name for a branch, will use as the default domain prefix.
    
    Returns:
    
    Display name for a branch, will use as the default domain prefix.
  - withDisplayName
```
public CreateBranchRequest withDisplayName(String displayName)
```
    Display name for a branch, will use as the default domain prefix.
    
    Parameters:
    
    displayName - Display name for a branch, will use as the default domain prefix.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnablePullRequestPreview
```
public void setEnablePullRequestPreview(Boolean enablePullRequestPreview)
```
    Enables Pull Request Preview for this branch.
    
    Parameters:
    
    enablePullRequestPreview - Enables Pull Request Preview for this branch.
  - getEnablePullRequestPreview
```
public Boolean getEnablePullRequestPreview()
```
    Enables Pull Request Preview for this branch.
    
    Returns:
    
    Enables Pull Request Preview for this branch.
  - withEnablePullRequestPreview
```
public CreateBranchRequest withEnablePullRequestPreview(Boolean enablePullRequestPreview)
```
    Enables Pull Request Preview for this branch.
    
    Parameters:
    
    enablePullRequestPreview - Enables Pull Request Preview for this branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnablePullRequestPreview
```
public Boolean isEnablePullRequestPreview()
```
    Enables Pull Request Preview for this branch.
    
    Returns:
    
    Enables Pull Request Preview for this branch.
  - setPullRequestEnvironmentName
```
public void setPullRequestEnvironmentName(String pullRequestEnvironmentName)
```
    The Amplify Environment name for the pull request.
    
    Parameters:
    
    pullRequestEnvironmentName - The Amplify Environment name for the pull request.
  - getPullRequestEnvironmentName
```
public String getPullRequestEnvironmentName()
```
    The Amplify Environment name for the pull request.
    
    Returns:
    
    The Amplify Environment name for the pull request.
  - withPullRequestEnvironmentName
```
public CreateBranchRequest withPullRequestEnvironmentName(String pullRequestEnvironmentName)
```
    The Amplify Environment name for the pull request.
    
    Parameters:
    
    pullRequestEnvironmentName - The Amplify Environment name for the pull request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackendEnvironmentArn
```
public void setBackendEnvironmentArn(String backendEnvironmentArn)
```
    ARN for a Backend Environment, part of an Amplify App.
    
    Parameters:
    
    backendEnvironmentArn - ARN for a Backend Environment, part of an Amplify App.
  - getBackendEnvironmentArn
```
public String getBackendEnvironmentArn()
```
    ARN for a Backend Environment, part of an Amplify App.
    
    Returns:
    
    ARN for a Backend Environment, part of an Amplify App.
  - withBackendEnvironmentArn
```
public CreateBranchRequest withBackendEnvironmentArn(String backendEnvironmentArn)
```
    ARN for a Backend Environment, part of an Amplify App.
    
    Parameters:
    
    backendEnvironmentArn - ARN for a Backend Environment, part of an Amplify App.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateBranchRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateBranchRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateBranchRequest

Method Detail

setAppId

getAppId

withAppId

setBranchName

getBranchName

withBranchName

setDescription

getDescription

withDescription

setStage

getStage

withStage

withStage

setFramework

getFramework

withFramework

setEnableNotification

getEnableNotification

withEnableNotification

isEnableNotification

setEnableAutoBuild

getEnableAutoBuild

withEnableAutoBuild

isEnableAutoBuild

getEnvironmentVariables

setEnvironmentVariables

withEnvironmentVariables

addEnvironmentVariablesEntry

clearEnvironmentVariablesEntries

setBasicAuthCredentials

getBasicAuthCredentials

withBasicAuthCredentials

setEnableBasicAuth

getEnableBasicAuth

withEnableBasicAuth

isEnableBasicAuth

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setBuildSpec

getBuildSpec

withBuildSpec

setTtl

getTtl

withTtl

setDisplayName

getDisplayName

withDisplayName

setEnablePullRequestPreview

getEnablePullRequestPreview

withEnablePullRequestPreview

isEnablePullRequestPreview

setPullRequestEnvironmentName

getPullRequestEnvironmentName

withPullRequestEnvironmentName

setBackendEnvironmentArn

getBackendEnvironmentArn

withBackendEnvironmentArn

toString

equals

hashCode

clone