Branch (AWS Java SDK :: Services :: Amplify 2.17.269 API)

java.lang.Object
- software.amazon.awssdk.services.amplify.model.Branch

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Branch.Builder,Branch>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Branch
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Branch.Builder,Branch>
```
The branch for an Amplify app, which maps to a third-party repository branch.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Branch.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Branch.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`activeJobId()` The ID of the active job for a branch of an Amplify app.
`List<String>`	`associatedResources()` A list of custom resources that are linked to this branch.
`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 a branch of an Amplify app.
`String`	`branchArn()` The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
`String`	`branchName()` The name for the branch that is part of an Amplify app.
`static Branch.Builder`	`builder()`
`String`	`buildSpec()` The build specification (build spec) content for the branch of an Amplify app.
`Instant`	`createTime()` The creation date and time for a branch that is part of an Amplify app.
`List<String>`	`customDomains()` The custom domains for a branch of an Amplify app.
`String`	`description()` The description for the branch that is part of an Amplify app.
`String`	`destinationBranch()` The destination branch if the branch is a pull request branch.
`String`	`displayName()` The display name for the branch.
`Boolean`	`enableAutoBuild()` Enables auto-building on push for a branch of an Amplify app.
`Boolean`	`enableBasicAuth()` Enables basic authorization for a branch of an Amplify app.
`Boolean`	`enableNotification()` Enables notifications for a branch that is part of an Amplify app.
`Boolean`	`enablePerformanceMode()` Enables performance mode for the branch.
`Boolean`	`enablePullRequestPreview()` Enables pull request previews for the branch.
`Map<String,String>`	`environmentVariables()` The environment variables specific to a branch of an Amplify app.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`framework()` The framework for a branch of an Amplify app.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAssociatedResources()` For responses, this returns true if the service returned a value for the AssociatedResources property.
`boolean`	`hasCustomDomains()` For responses, this returns true if the service returned a value for the CustomDomains property.
`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 Branch.Builder>`	`serializableBuilderClass()`
`String`	`sourceBranch()` The source branch if the branch is a pull request branch.
`Stage`	`stage()` The current stage for the branch that is part of an Amplify app.
`String`	`stageAsString()` The current stage for the branch that is part of an Amplify app.
`Map<String,String>`	`tags()` The tag for the branch of an Amplify app.
`String`	`thumbnailUrl()` The thumbnail URL for the branch of an Amplify app.
`Branch.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`totalNumberOfJobs()` The total number of jobs that are part of an Amplify app.
`String`	`ttl()` The content Time to Live (TTL) for the website in seconds.
`Instant`	`updateTime()` The last updated date and time for a branch that is part of an Amplify app.

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
  - branchArn
```
public final String branchArn()
```
    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.
  - branchName
```
public final String branchName()
```
    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.
  - description
```
public final String description()
```
    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.
  - 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 of an Amplify app.
    
    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 of an Amplify app.
  - stage
```
public final Stage stage()
```
    The current stage for the branch that is part of an Amplify app.
    
    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:
    
    The current stage for the branch that is part of an Amplify app.
    
    See Also:
    
    Stage
  - stageAsString
```
public final String stageAsString()
```
    The current stage for the branch that is part of an Amplify app.
    
    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:
    
    The current stage for the branch that is part of an Amplify app.
    
    See Also:
    
    Stage
  - displayName
```
public final String displayName()
```
    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.
  - enableNotification
```
public final Boolean enableNotification()
```
    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.
  - createTime
```
public final Instant createTime()
```
    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.
  - updateTime
```
public final Instant updateTime()
```
    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.
  - 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 specific to a branch of an Amplify app.
    
    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 specific to a branch of an Amplify app.
  - enableAutoBuild
```
public final Boolean enableAutoBuild()
```
    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.
  - hasCustomDomains
```
public final boolean hasCustomDomains()
```
    For responses, this returns true if the service returned a value for the CustomDomains 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.
  - customDomains
```
public final List<String> customDomains()
```
    The custom domains for a branch of an Amplify app.
    
    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 hasCustomDomains() method.
    
    Returns:
    
    The custom domains for a branch of an Amplify app.
  - framework
```
public final String framework()
```
    The framework for a branch of an Amplify app.
    
    Returns:
    
    The framework for a branch of an Amplify app.
  - activeJobId
```
public final String activeJobId()
```
    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.
  - totalNumberOfJobs
```
public final String totalNumberOfJobs()
```
    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.
  - enableBasicAuth
```
public final Boolean enableBasicAuth()
```
    Enables basic authorization for a branch of an Amplify app.
    
    Returns:
    
    Enables basic authorization for a branch of an Amplify app.
  - 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.
  - thumbnailUrl
```
public final String thumbnailUrl()
```
    The thumbnail URL for the branch of an Amplify app.
    
    Returns:
    
    The thumbnail URL for the branch of an Amplify app.
  - basicAuthCredentials
```
public final 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.
    
    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.
  - buildSpec
```
public final String buildSpec()
```
    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.
  - 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.
  - hasAssociatedResources
```
public final boolean hasAssociatedResources()
```
    For responses, this returns true if the service returned a value for the AssociatedResources 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.
  - associatedResources
```
public final List<String> associatedResources()
```
    A list of custom resources that are linked to this 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 hasAssociatedResources() method.
    
    Returns:
    
    A list of custom resources that are linked to this branch.
  - enablePullRequestPreview
```
public final Boolean enablePullRequestPreview()
```
    Enables pull request previews for the branch.
    
    Returns:
    
    Enables pull request previews for the branch.
  - pullRequestEnvironmentName
```
public final String pullRequestEnvironmentName()
```
    The Amplify environment name for the pull request.
    
    Returns:
    
    The Amplify environment name for the pull request.
  - destinationBranch
```
public final String destinationBranch()
```
    The destination branch if the branch is a pull request branch.
    
    Returns:
    
    The destination branch if the branch is a pull request branch.
  - sourceBranch
```
public final String sourceBranch()
```
    The source branch if the branch is a pull request branch.
    
    Returns:
    
    The source branch if the branch is a pull request branch.
  - 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 Branch.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Branch.Builder,Branch>
  - builder
```
public static Branch.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Branch.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Branch

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

branchArn

branchName

description

hasTags

tags

stage

stageAsString

displayName

enableNotification

createTime

updateTime

hasEnvironmentVariables

environmentVariables

enableAutoBuild

hasCustomDomains

customDomains

framework

activeJobId

totalNumberOfJobs

enableBasicAuth

enablePerformanceMode

thumbnailUrl

basicAuthCredentials

buildSpec

ttl

hasAssociatedResources

associatedResources

enablePullRequestPreview

pullRequestEnvironmentName

destinationBranch

sourceBranch

backendEnvironmentArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields