Branch (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.amplify.model.Branch

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Branch
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The branch for an Amplify app, which maps to a third-party repository branch.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Branch()

Constructors
Constructor and Description
`Branch()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Branch`	`addEnvironmentVariablesEntry(String key, String value)` Add a single EnvironmentVariables entry
`Branch`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Branch`	`clearEnvironmentVariablesEntries()` Removes all the entries added into EnvironmentVariables.
`Branch`	`clearTagsEntries()` Removes all the entries added into Tags.
`Branch`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getActiveJobId()` The ID of the active job for a branch of an Amplify app.
`List<String>`	`getAssociatedResources()` A list of custom resources that are linked to this branch.
`Backend`	`getBackend()`
`String`	`getBackendEnvironmentArn()` The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
`String`	`getBasicAuthCredentials()` The basic authorization credentials for a branch of an Amplify app.
`String`	`getBranchArn()` The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
`String`	`getBranchName()` The name for the branch that is part of an Amplify app.
`String`	`getBuildSpec()` The build specification (build spec) content for the branch of an Amplify app.
`Date`	`getCreateTime()` The creation date and time for a branch that is part of an Amplify app.
`List<String>`	`getCustomDomains()` The custom domains for a branch of an Amplify app.
`String`	`getDescription()` The description for the branch that is part of an Amplify app.
`String`	`getDestinationBranch()` The destination branch if the branch is a pull request branch.
`String`	`getDisplayName()` The display name for the branch.
`Boolean`	`getEnableAutoBuild()` Enables auto-building on push for a branch of an Amplify app.
`Boolean`	`getEnableBasicAuth()` Enables basic authorization for a branch of an Amplify app.
`Boolean`	`getEnableNotification()` Enables notifications for a branch that is part of an Amplify app.
`Boolean`	`getEnablePerformanceMode()` Enables performance mode for the branch.
`Boolean`	`getEnablePullRequestPreview()` Enables pull request previews for the branch.
`Map<String,String>`	`getEnvironmentVariables()` The environment variables specific to a branch of an Amplify app.
`String`	`getFramework()` The framework for a branch of an Amplify app.
`String`	`getPullRequestEnvironmentName()` The Amplify environment name for the pull request.
`String`	`getSourceBranch()` The source branch if the branch is a pull request branch.
`String`	`getStage()` The current stage for the branch that is part of an Amplify app.
`Map<String,String>`	`getTags()` The tag for the branch of an Amplify app.
`String`	`getThumbnailUrl()` The thumbnail URL for the branch of an Amplify app.
`String`	`getTotalNumberOfJobs()` The total number of jobs that are part of an Amplify app.
`String`	`getTtl()` The content Time to Live (TTL) for the website in seconds.
`Date`	`getUpdateTime()` The last updated date and time for a branch that is part of an Amplify app.
`int`	`hashCode()`
`Boolean`	`isEnableAutoBuild()` Enables auto-building on push for a branch of an Amplify app.
`Boolean`	`isEnableBasicAuth()` Enables basic authorization for a branch of an Amplify app.
`Boolean`	`isEnableNotification()` Enables notifications for a branch that is part of an Amplify app.
`Boolean`	`isEnablePerformanceMode()` Enables performance mode for the branch.
`Boolean`	`isEnablePullRequestPreview()` Enables pull request previews for the branch.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActiveJobId(String activeJobId)` The ID of the active job for a branch of an Amplify app.
`void`	`setAssociatedResources(Collection<String> associatedResources)` A list of custom resources that are linked to this branch.
`void`	`setBackend(Backend backend)`
`void`	`setBackendEnvironmentArn(String backendEnvironmentArn)` The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
`void`	`setBasicAuthCredentials(String basicAuthCredentials)` The basic authorization credentials for a branch of an Amplify app.
`void`	`setBranchArn(String branchArn)` The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
`void`	`setBranchName(String branchName)` The name for the branch that is part of an Amplify app.
`void`	`setBuildSpec(String buildSpec)` The build specification (build spec) content for the branch of an Amplify app.
`void`	`setCreateTime(Date createTime)` The creation date and time for a branch that is part of an Amplify app.
`void`	`setCustomDomains(Collection<String> customDomains)` The custom domains for a branch of an Amplify app.
`void`	`setDescription(String description)` The description for the branch that is part of an Amplify app.
`void`	`setDestinationBranch(String destinationBranch)` The destination branch if the branch is a pull request branch.
`void`	`setDisplayName(String displayName)` The display name for the branch.
`void`	`setEnableAutoBuild(Boolean enableAutoBuild)` Enables auto-building on push for a branch of an Amplify app.
`void`	`setEnableBasicAuth(Boolean enableBasicAuth)` Enables basic authorization for a branch of an Amplify app.
`void`	`setEnableNotification(Boolean enableNotification)` Enables notifications for a branch that is part of an Amplify app.
`void`	`setEnablePerformanceMode(Boolean enablePerformanceMode)` Enables performance mode for the branch.
`void`	`setEnablePullRequestPreview(Boolean enablePullRequestPreview)` Enables pull request previews for the branch.
`void`	`setEnvironmentVariables(Map<String,String> environmentVariables)` The environment variables specific to a branch of an Amplify app.
`void`	`setFramework(String framework)` The framework for a branch of an Amplify app.
`void`	`setPullRequestEnvironmentName(String pullRequestEnvironmentName)` The Amplify environment name for the pull request.
`void`	`setSourceBranch(String sourceBranch)` The source branch if the branch is a pull request branch.
`void`	`setStage(String stage)` The current stage for the branch that is part of an Amplify app.
`void`	`setTags(Map<String,String> tags)` The tag for the branch of an Amplify app.
`void`	`setThumbnailUrl(String thumbnailUrl)` The thumbnail URL for the branch of an Amplify app.
`void`	`setTotalNumberOfJobs(String totalNumberOfJobs)` The total number of jobs that are part of an Amplify app.
`void`	`setTtl(String ttl)` The content Time to Live (TTL) for the website in seconds.
`void`	`setUpdateTime(Date updateTime)` The last updated date and time for a branch that is part of an Amplify app.
`String`	`toString()` Returns a string representation of this object.
`Branch`	`withActiveJobId(String activeJobId)` The ID of the active job for a branch of an Amplify app.
`Branch`	`withAssociatedResources(Collection<String> associatedResources)` A list of custom resources that are linked to this branch.
`Branch`	`withAssociatedResources(String... associatedResources)` A list of custom resources that are linked to this branch.
`Branch`	`withBackend(Backend backend)`
`Branch`	`withBackendEnvironmentArn(String backendEnvironmentArn)` The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
`Branch`	`withBasicAuthCredentials(String basicAuthCredentials)` The basic authorization credentials for a branch of an Amplify app.
`Branch`	`withBranchArn(String branchArn)` The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
`Branch`	`withBranchName(String branchName)` The name for the branch that is part of an Amplify app.
`Branch`	`withBuildSpec(String buildSpec)` The build specification (build spec) content for the branch of an Amplify app.
`Branch`	`withCreateTime(Date createTime)` The creation date and time for a branch that is part of an Amplify app.
`Branch`	`withCustomDomains(Collection<String> customDomains)` The custom domains for a branch of an Amplify app.
`Branch`	`withCustomDomains(String... customDomains)` The custom domains for a branch of an Amplify app.
`Branch`	`withDescription(String description)` The description for the branch that is part of an Amplify app.
`Branch`	`withDestinationBranch(String destinationBranch)` The destination branch if the branch is a pull request branch.
`Branch`	`withDisplayName(String displayName)` The display name for the branch.
`Branch`	`withEnableAutoBuild(Boolean enableAutoBuild)` Enables auto-building on push for a branch of an Amplify app.
`Branch`	`withEnableBasicAuth(Boolean enableBasicAuth)` Enables basic authorization for a branch of an Amplify app.
`Branch`	`withEnableNotification(Boolean enableNotification)` Enables notifications for a branch that is part of an Amplify app.
`Branch`	`withEnablePerformanceMode(Boolean enablePerformanceMode)` Enables performance mode for the branch.
`Branch`	`withEnablePullRequestPreview(Boolean enablePullRequestPreview)` Enables pull request previews for the branch.
`Branch`	`withEnvironmentVariables(Map<String,String> environmentVariables)` The environment variables specific to a branch of an Amplify app.
`Branch`	`withFramework(String framework)` The framework for a branch of an Amplify app.
`Branch`	`withPullRequestEnvironmentName(String pullRequestEnvironmentName)` The Amplify environment name for the pull request.
`Branch`	`withSourceBranch(String sourceBranch)` The source branch if the branch is a pull request branch.
`Branch`	`withStage(Stage stage)` The current stage for the branch that is part of an Amplify app.
`Branch`	`withStage(String stage)` The current stage for the branch that is part of an Amplify app.
`Branch`	`withTags(Map<String,String> tags)` The tag for the branch of an Amplify app.
`Branch`	`withThumbnailUrl(String thumbnailUrl)` The thumbnail URL for the branch of an Amplify app.
`Branch`	`withTotalNumberOfJobs(String totalNumberOfJobs)` The total number of jobs that are part of an Amplify app.
`Branch`	`withTtl(String ttl)` The content Time to Live (TTL) for the website in seconds.
`Branch`	`withUpdateTime(Date updateTime)` The last updated date and time for a branch that is part of an Amplify app.

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

- Constructor Detail
  - Branch
```
public Branch()
```
- Method Detail
  - setBranchArn
```
public void setBranchArn(String branchArn)
```
    The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
    
    Parameters:
    
    branchArn - The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
  - getBranchArn
```
public String getBranchArn()
```
    The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
    
    Returns:
    
    The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
  - withBranchArn
```
public Branch withBranchArn(String branchArn)
```
    The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
    
    Parameters:
    
    branchArn - The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBranchName
```
public void setBranchName(String branchName)
```
    The name for the branch that is part of an Amplify app.
    
    Parameters:
    
    branchName - The name for the branch that is part of an Amplify app.
  - getBranchName
```
public String getBranchName()
```
    The name for the branch that is part of an Amplify app.
    
    Returns:
    
    The name for the branch that is part of an Amplify app.
  - withBranchName
```
public Branch withBranchName(String branchName)
```
    The name for the branch that is part of an Amplify app.
    
    Parameters:
    
    branchName - The name for the branch that is part of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description for the branch that is part of an Amplify app.
    
    Parameters:
    
    description - The description for the branch that is part of an Amplify app.
  - getDescription
```
public String getDescription()
```
    The description for the branch that is part of an Amplify app.
    
    Returns:
    
    The description for the branch that is part of an Amplify app.
  - withDescription
```
public Branch withDescription(String description)
```
    The description for the branch that is part of an Amplify app.
    
    Parameters:
    
    description - The description for the branch that is part of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tag for the branch of an Amplify app.
    
    Returns:
    
    The tag for the branch of an Amplify app.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tag for the branch of an Amplify app.
    
    Parameters:
    
    tags - The tag for the branch of an Amplify app.
  - withTags
```
public Branch withTags(Map<String,String> tags)
```
    The tag for the branch of an Amplify app.
    
    Parameters:
    
    tags - The tag for the branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Branch addTagsEntry(String key,
                           String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Branch clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStage
```
public void setStage(String stage)
```
    The current stage for the branch that is part of an Amplify app.
    
    Parameters:
    
    stage - The current stage for the branch that is part of an Amplify app.
    
    See Also:
    
    Stage
  - getStage
```
public String getStage()
```
    The current stage for the branch that is part of an Amplify app.
    
    Returns:
    
    The current stage for the branch that is part of an Amplify app.
    
    See Also:
    
    Stage
  - withStage
```
public Branch withStage(String stage)
```
    The current stage for the branch that is part of an Amplify app.
    
    Parameters:
    
    stage - The current stage for the branch that is part of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Stage
  - withStage
```
public Branch withStage(Stage stage)
```
    The current stage for the branch that is part of an Amplify app.
    
    Parameters:
    
    stage - The current stage for the branch that is part of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Stage
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    The display name for the branch. This is used as the default domain prefix.
    
    Parameters:
    
    displayName - The display name for the branch. This is used as the default domain prefix.
  - getDisplayName
```
public String getDisplayName()
```
    The display name for the branch. This is used as the default domain prefix.
    
    Returns:
    
    The display name for the branch. This is used as the default domain prefix.
  - withDisplayName
```
public Branch withDisplayName(String displayName)
```
    The display name for the branch. This is used as the default domain prefix.
    
    Parameters:
    
    displayName - The display name for the branch. This is used as the default domain prefix.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnableNotification
```
public void setEnableNotification(Boolean enableNotification)
```
    Enables notifications for a branch that is part of an Amplify app.
    
    Parameters:
    
    enableNotification - Enables notifications for a branch that is part of an Amplify app.
  - getEnableNotification
```
public Boolean getEnableNotification()
```
    Enables notifications for a branch that is part of an Amplify app.
    
    Returns:
    
    Enables notifications for a branch that is part of an Amplify app.
  - withEnableNotification
```
public Branch withEnableNotification(Boolean enableNotification)
```
    Enables notifications for a branch that is part of an Amplify app.
    
    Parameters:
    
    enableNotification - Enables notifications for a branch that is part of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableNotification
```
public Boolean isEnableNotification()
```
    Enables notifications for a branch that is part of an Amplify app.
    
    Returns:
    
    Enables notifications for a branch that is part of an Amplify app.
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
    The creation date and time for a branch that is part of an Amplify app.
    
    Parameters:
    
    createTime - The creation date and time for a branch that is part of an Amplify app.
  - getCreateTime
```
public Date getCreateTime()
```
    The creation date and time for a branch that is part of an Amplify app.
    
    Returns:
    
    The creation date and time for a branch that is part of an Amplify app.
  - withCreateTime
```
public Branch withCreateTime(Date createTime)
```
    The creation date and time for a branch that is part of an Amplify app.
    
    Parameters:
    
    createTime - The creation date and time for a branch that is part of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdateTime
```
public void setUpdateTime(Date updateTime)
```
    The last updated date and time for a branch that is part of an Amplify app.
    
    Parameters:
    
    updateTime - The last updated date and time for a branch that is part of an Amplify app.
  - getUpdateTime
```
public Date getUpdateTime()
```
    The last updated date and time for a branch that is part of an Amplify app.
    
    Returns:
    
    The last updated date and time for a branch that is part of an Amplify app.
  - withUpdateTime
```
public Branch withUpdateTime(Date updateTime)
```
    The last updated date and time for a branch that is part of an Amplify app.
    
    Parameters:
    
    updateTime - The last updated date and time for a branch that is part of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEnvironmentVariables
```
public Map<String,String> getEnvironmentVariables()
```
    The environment variables specific to a branch of an Amplify app.
    
    Returns:
    
    The environment variables specific to a branch of an Amplify app.
  - setEnvironmentVariables
```
public void setEnvironmentVariables(Map<String,String> environmentVariables)
```
    The environment variables specific to a branch of an Amplify app.
    
    Parameters:
    
    environmentVariables - The environment variables specific to a branch of an Amplify app.
  - withEnvironmentVariables
```
public Branch withEnvironmentVariables(Map<String,String> environmentVariables)
```
    The environment variables specific to a branch of an Amplify app.
    
    Parameters:
    
    environmentVariables - The environment variables specific to a branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addEnvironmentVariablesEntry
```
public Branch addEnvironmentVariablesEntry(String key,
                                           String value)
```
    Add a single EnvironmentVariables entry
    
    See Also:
    
    withEnvironmentVariables(java.util.Map<java.lang.String, java.lang.String>)
  - clearEnvironmentVariablesEntries
```
public Branch clearEnvironmentVariablesEntries()
```
    Removes all the entries added into EnvironmentVariables.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnableAutoBuild
```
public void setEnableAutoBuild(Boolean enableAutoBuild)
```
    Enables auto-building on push for a branch of an Amplify app.
    
    Parameters:
    
    enableAutoBuild - Enables auto-building on push for a branch of an Amplify app.
  - getEnableAutoBuild
```
public Boolean getEnableAutoBuild()
```
    Enables auto-building on push for a branch of an Amplify app.
    
    Returns:
    
    Enables auto-building on push for a branch of an Amplify app.
  - withEnableAutoBuild
```
public Branch withEnableAutoBuild(Boolean enableAutoBuild)
```
    Enables auto-building on push for a branch of an Amplify app.
    
    Parameters:
    
    enableAutoBuild - Enables auto-building on push for a branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableAutoBuild
```
public Boolean isEnableAutoBuild()
```
    Enables auto-building on push for a branch of an Amplify app.
    
    Returns:
    
    Enables auto-building on push for a branch of an Amplify app.
  - getCustomDomains
```
public List<String> getCustomDomains()
```
    The custom domains for a branch of an Amplify app.
    
    Returns:
    
    The custom domains for a branch of an Amplify app.
  - setCustomDomains
```
public void setCustomDomains(Collection<String> customDomains)
```
    The custom domains for a branch of an Amplify app.
    
    Parameters:
    
    customDomains - The custom domains for a branch of an Amplify app.
  - withCustomDomains
```
public Branch withCustomDomains(String... customDomains)
```
    The custom domains for a branch of an Amplify app.
    
    NOTE: This method appends the values to the existing list (if any). Use setCustomDomains(java.util.Collection) or withCustomDomains(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    customDomains - The custom domains for a branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCustomDomains
```
public Branch withCustomDomains(Collection<String> customDomains)
```
    The custom domains for a branch of an Amplify app.
    
    Parameters:
    
    customDomains - The custom domains for a branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFramework
```
public void setFramework(String framework)
```
    The framework for a branch of an Amplify app.
    
    Parameters:
    
    framework - The framework for a branch of an Amplify app.
  - getFramework
```
public String getFramework()
```
    The framework for a branch of an Amplify app.
    
    Returns:
    
    The framework for a branch of an Amplify app.
  - withFramework
```
public Branch withFramework(String framework)
```
    The framework for a branch of an Amplify app.
    
    Parameters:
    
    framework - The framework for a branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setActiveJobId
```
public void setActiveJobId(String activeJobId)
```
    The ID of the active job for a branch of an Amplify app.
    
    Parameters:
    
    activeJobId - The ID of the active job for a branch of an Amplify app.
  - getActiveJobId
```
public String getActiveJobId()
```
    The ID of the active job for a branch of an Amplify app.
    
    Returns:
    
    The ID of the active job for a branch of an Amplify app.
  - withActiveJobId
```
public Branch withActiveJobId(String activeJobId)
```
    The ID of the active job for a branch of an Amplify app.
    
    Parameters:
    
    activeJobId - The ID of the active job for a branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalNumberOfJobs
```
public void setTotalNumberOfJobs(String totalNumberOfJobs)
```
    The total number of jobs that are part of an Amplify app.
    
    Parameters:
    
    totalNumberOfJobs - The total number of jobs that are part of an Amplify app.
  - getTotalNumberOfJobs
```
public String getTotalNumberOfJobs()
```
    The total number of jobs that are part of an Amplify app.
    
    Returns:
    
    The total number of jobs that are part of an Amplify app.
  - withTotalNumberOfJobs
```
public Branch withTotalNumberOfJobs(String totalNumberOfJobs)
```
    The total number of jobs that are part of an Amplify app.
    
    Parameters:
    
    totalNumberOfJobs - The total number of jobs that are part of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnableBasicAuth
```
public void setEnableBasicAuth(Boolean enableBasicAuth)
```
    Enables basic authorization for a branch of an Amplify app.
    
    Parameters:
    
    enableBasicAuth - Enables basic authorization for a branch of an Amplify app.
  - getEnableBasicAuth
```
public Boolean getEnableBasicAuth()
```
    Enables basic authorization for a branch of an Amplify app.
    
    Returns:
    
    Enables basic authorization for a branch of an Amplify app.
  - withEnableBasicAuth
```
public Branch withEnableBasicAuth(Boolean enableBasicAuth)
```
    Enables basic authorization for a branch of an Amplify app.
    
    Parameters:
    
    enableBasicAuth - Enables basic authorization for a branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableBasicAuth
```
public Boolean isEnableBasicAuth()
```
    Enables basic authorization for a branch of an Amplify app.
    
    Returns:
    
    Enables basic authorization for a branch of an Amplify app.
  - setEnablePerformanceMode
```
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.
    
    Parameters:
    
    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.
  - getEnablePerformanceMode
```
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.
    
    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.
  - withEnablePerformanceMode
```
public Branch 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnablePerformanceMode
```
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.
    
    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.
  - setThumbnailUrl
```
public void setThumbnailUrl(String thumbnailUrl)
```
    The thumbnail URL for the branch of an Amplify app.
    
    Parameters:
    
    thumbnailUrl - The thumbnail URL for the branch of an Amplify app.
  - getThumbnailUrl
```
public String getThumbnailUrl()
```
    The thumbnail URL for the branch of an Amplify app.
    
    Returns:
    
    The thumbnail URL for the branch of an Amplify app.
  - withThumbnailUrl
```
public Branch withThumbnailUrl(String thumbnailUrl)
```
    The thumbnail URL for the branch of an Amplify app.
    
    Parameters:
    
    thumbnailUrl - The thumbnail URL for the branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBasicAuthCredentials
```
public void setBasicAuthCredentials(String basicAuthCredentials)
```
    The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
    
    Parameters:
    
    basicAuthCredentials - The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
  - getBasicAuthCredentials
```
public String getBasicAuthCredentials()
```
    The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
    
    Returns:
    
    The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
  - withBasicAuthCredentials
```
public Branch withBasicAuthCredentials(String basicAuthCredentials)
```
    The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
    
    Parameters:
    
    basicAuthCredentials - The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBuildSpec
```
public void setBuildSpec(String buildSpec)
```
    The build specification (build spec) content for the branch of an Amplify app.
    
    Parameters:
    
    buildSpec - The build specification (build spec) content for the branch of an Amplify app.
  - getBuildSpec
```
public String getBuildSpec()
```
    The build specification (build spec) content for the branch of an Amplify app.
    
    Returns:
    
    The build specification (build spec) content for the branch of an Amplify app.
  - withBuildSpec
```
public Branch withBuildSpec(String buildSpec)
```
    The build specification (build spec) content for the branch of an Amplify app.
    
    Parameters:
    
    buildSpec - The build specification (build spec) content for the branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTtl
```
public void setTtl(String ttl)
```
    The content Time to Live (TTL) for the website in seconds.
    
    Parameters:
    
    ttl - The content Time to Live (TTL) for the website in seconds.
  - getTtl
```
public String getTtl()
```
    The content Time to Live (TTL) for the website in seconds.
    
    Returns:
    
    The content Time to Live (TTL) for the website in seconds.
  - withTtl
```
public Branch withTtl(String ttl)
```
    The content Time to Live (TTL) for the website in seconds.
    
    Parameters:
    
    ttl - The content Time to Live (TTL) for the website in seconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAssociatedResources
```
public List<String> getAssociatedResources()
```
    A list of custom resources that are linked to this branch.
    
    Returns:
    
    A list of custom resources that are linked to this branch.
  - setAssociatedResources
```
public void setAssociatedResources(Collection<String> associatedResources)
```
    A list of custom resources that are linked to this branch.
    
    Parameters:
    
    associatedResources - A list of custom resources that are linked to this branch.
  - withAssociatedResources
```
public Branch withAssociatedResources(String... associatedResources)
```
    A list of custom resources that are linked to this branch.
    
    NOTE: This method appends the values to the existing list (if any). Use setAssociatedResources(java.util.Collection) or withAssociatedResources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    associatedResources - A list of custom resources that are linked to this branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAssociatedResources
```
public Branch withAssociatedResources(Collection<String> associatedResources)
```
    A list of custom resources that are linked to this branch.
    
    Parameters:
    
    associatedResources - A list of custom resources that are linked to this branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnablePullRequestPreview
```
public void setEnablePullRequestPreview(Boolean enablePullRequestPreview)
```
    Enables pull request previews for the branch.
    
    Parameters:
    
    enablePullRequestPreview - Enables pull request previews for the branch.
  - getEnablePullRequestPreview
```
public Boolean getEnablePullRequestPreview()
```
    Enables pull request previews for the branch.
    
    Returns:
    
    Enables pull request previews for the branch.
  - withEnablePullRequestPreview
```
public Branch withEnablePullRequestPreview(Boolean enablePullRequestPreview)
```
    Enables pull request previews for the branch.
    
    Parameters:
    
    enablePullRequestPreview - Enables pull request previews for the branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnablePullRequestPreview
```
public Boolean isEnablePullRequestPreview()
```
    Enables pull request previews for the branch.
    
    Returns:
    
    Enables pull request previews for the 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 Branch 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.
  - setDestinationBranch
```
public void setDestinationBranch(String destinationBranch)
```
    The destination branch if the branch is a pull request branch.
    
    Parameters:
    
    destinationBranch - The destination branch if the branch is a pull request branch.
  - getDestinationBranch
```
public String getDestinationBranch()
```
    The destination branch if the branch is a pull request branch.
    
    Returns:
    
    The destination branch if the branch is a pull request branch.
  - withDestinationBranch
```
public Branch withDestinationBranch(String destinationBranch)
```
    The destination branch if the branch is a pull request branch.
    
    Parameters:
    
    destinationBranch - The destination branch if the branch is a pull request branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceBranch
```
public void setSourceBranch(String sourceBranch)
```
    The source branch if the branch is a pull request branch.
    
    Parameters:
    
    sourceBranch - The source branch if the branch is a pull request branch.
  - getSourceBranch
```
public String getSourceBranch()
```
    The source branch if the branch is a pull request branch.
    
    Returns:
    
    The source branch if the branch is a pull request branch.
  - withSourceBranch
```
public Branch withSourceBranch(String sourceBranch)
```
    The source branch if the branch is a pull request branch.
    
    Parameters:
    
    sourceBranch - The source branch if the branch is a pull request branch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackendEnvironmentArn
```
public void setBackendEnvironmentArn(String backendEnvironmentArn)
```
    The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
    
    This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
    
    Parameters:
    
    backendEnvironmentArn - The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
    
    This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
  - getBackendEnvironmentArn
```
public String getBackendEnvironmentArn()
```
    The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
    
    This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
    
    Returns:
    
    The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
    
    This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
  - withBackendEnvironmentArn
```
public Branch withBackendEnvironmentArn(String backendEnvironmentArn)
```
    The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
    
    This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
    
    Parameters:
    
    backendEnvironmentArn - The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
    
    This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackend
```
public void setBackend(Backend backend)
```
    Parameters:
    
    backend -
  - getBackend
```
public Backend getBackend()
```
    Returns:
  - withBackend
```
public Branch withBackend(Backend backend)
```
    Parameters:
    
    backend -
    
    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 Branch clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class Branch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Branch

Method Detail

setBranchArn

getBranchArn

withBranchArn

setBranchName

getBranchName

withBranchName

setDescription

getDescription

withDescription

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setStage

getStage

withStage

withStage

setDisplayName

getDisplayName

withDisplayName

setEnableNotification

getEnableNotification

withEnableNotification

isEnableNotification

setCreateTime

getCreateTime

withCreateTime

setUpdateTime

getUpdateTime

withUpdateTime

getEnvironmentVariables

setEnvironmentVariables

withEnvironmentVariables

addEnvironmentVariablesEntry

clearEnvironmentVariablesEntries

setEnableAutoBuild

getEnableAutoBuild

withEnableAutoBuild

isEnableAutoBuild

getCustomDomains

setCustomDomains

withCustomDomains

withCustomDomains

setFramework

getFramework

withFramework

setActiveJobId

getActiveJobId

withActiveJobId

setTotalNumberOfJobs

getTotalNumberOfJobs

withTotalNumberOfJobs

setEnableBasicAuth

getEnableBasicAuth

withEnableBasicAuth

isEnableBasicAuth

setEnablePerformanceMode

getEnablePerformanceMode

withEnablePerformanceMode

isEnablePerformanceMode

setThumbnailUrl

getThumbnailUrl

withThumbnailUrl

setBasicAuthCredentials

getBasicAuthCredentials

withBasicAuthCredentials

setBuildSpec

getBuildSpec

withBuildSpec

setTtl

getTtl