Class Branch
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Branch.Builder,
Branch>
The branch for an Amplify app, which maps to a third-party repository branch.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID of the active job for a branch of an Amplify app.A list of custom resources that are linked to this branch.final Backend
backend()
Returns the value of the Backend property for this object.final String
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.final String
The basic authorization credentials for a branch of an Amplify app.final String
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.final String
The name for the branch that is part of an Amplify app.static Branch.Builder
builder()
final String
The build specification (build spec) content for the branch of an Amplify app.final Instant
The creation date and time for a branch that is part of an Amplify app.The custom domains for a branch of an Amplify app.final String
The description for the branch that is part of an Amplify app.final String
The destination branch if the branch is a pull request branch.final String
The display name for the branch.final Boolean
Enables auto-building on push for a branch of an Amplify app.final Boolean
Enables basic authorization for a branch of an Amplify app.final Boolean
Enables notifications for a branch that is part of an Amplify app.final Boolean
Enables performance mode for the branch.final Boolean
Enables pull request previews for the branch.The environment variables specific to a branch of an Amplify app.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The framework for a branch of an Amplify app.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AssociatedResources property.final boolean
For responses, this returns true if the service returned a value for the CustomDomains property.final boolean
For responses, this returns true if the service returned a value for the EnvironmentVariables property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The Amplify environment name for the pull request.static Class
<? extends Branch.Builder> final String
The source branch if the branch is a pull request branch.final Stage
stage()
The current stage for the branch that is part of an Amplify app.final String
The current stage for the branch that is part of an Amplify app.tags()
The tag for the branch of an Amplify app.final String
The thumbnail URL for the branch of an Amplify app.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The total number of jobs that are part of an Amplify app.final String
ttl()
The content Time to Live (TTL) for the website in seconds.final Instant
The last updated date and time for a branch that is part of an Amplify app.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 theisEmpty()
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
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
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 returnStage.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstageAsString()
.- Returns:
- The current stage for the branch that is part of an Amplify app.
- See Also:
-
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 returnStage.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstageAsString()
.- Returns:
- The current stage for the branch that is part of an Amplify app.
- See Also:
-
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
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
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
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 theisEmpty()
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
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
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 theisEmpty()
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
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
The framework for a branch of an Amplify app.
- Returns:
- The framework for a branch of an Amplify app.
-
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
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
Enables basic authorization for a branch of an Amplify app.
- Returns:
- Enables basic authorization for a branch of an Amplify app.
-
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
The thumbnail URL for the branch of an Amplify app.
- Returns:
- The thumbnail URL for the branch of an Amplify app.
-
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
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
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 theisEmpty()
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
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
Enables pull request previews for the branch.
- Returns:
- Enables pull request previews for the branch.
-
pullRequestEnvironmentName
The Amplify environment name for the pull request.
- Returns:
- The Amplify environment name for the pull request.
-
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
The source branch if the branch is a pull request branch.
- Returns:
- The source branch if the branch is a pull request branch.
-
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.
-
backend
Returns the value of the Backend property for this object.- Returns:
- The value of the Backend property for this object.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Branch.Builder,
Branch> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-