Class CreateBranchRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateBranchRequest.Builder,
CreateBranchRequest>
The request structure for the create branch request.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
appId()
The unique ID for an Amplify app.final Backend
backend()
The backend for aBranch
of an Amplify app.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 the branch.final String
The name for the branch.static CreateBranchRequest.Builder
builder()
final String
The build specification (build spec) for the branch.final String
The description for the branch.final String
The display name for a branch.final Boolean
Enables auto building for the branch.final Boolean
Enables basic authorization for the branch.final Boolean
Enables notifications for the branch.final Boolean
Enables performance mode for the branch.final Boolean
Enables pull request previews for this branch.The environment variables for the branch.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 the branch.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.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 CreateBranchRequest.Builder> final Stage
stage()
Describes the current stage for the branch.final String
Describes the current stage for the branch.tags()
The tag for the branch.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
ttl()
The content Time To Live (TTL) for the website in seconds.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
appId
The unique ID for an Amplify app.
- Returns:
- The unique ID for an Amplify app.
-
branchName
The name for the branch.
- Returns:
- The name for the branch.
-
description
The description for the branch.
- Returns:
- The description for the branch.
-
stage
Describes the current stage for the branch.
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:
- Describes the current stage for the branch.
- See Also:
-
stageAsString
Describes the current stage for the branch.
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:
- Describes the current stage for the branch.
- See Also:
-
framework
The framework for the branch.
- Returns:
- The framework for the branch.
-
enableNotification
Enables notifications for the branch.
- Returns:
- Enables notifications for the branch.
-
enableAutoBuild
Enables auto building for the branch.
- Returns:
- Enables auto building for the branch.
-
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 for the 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
hasEnvironmentVariables()
method.- Returns:
- The environment variables for the branch.
-
basicAuthCredentials
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format
user:password
.- Returns:
- The basic authorization credentials for the branch. You must base64-encode the authorization credentials
and provide them in the format
user:password
.
-
enableBasicAuth
Enables basic authorization for the branch.
- Returns:
- Enables basic authorization for the branch.
-
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.
-
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.
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.
-
buildSpec
The build specification (build spec) for the branch.
- Returns:
- The build specification (build spec) for the branch.
-
ttl
The content Time To Live (TTL) for the website in seconds.
- Returns:
- The content Time To Live (TTL) for the website in seconds.
-
displayName
The display name for a branch. This is used as the default domain prefix.
- Returns:
- The display name for a branch. This is used as the default domain prefix.
-
enablePullRequestPreview
Enables pull request previews for this branch.
- Returns:
- Enables pull request previews for this branch.
-
pullRequestEnvironmentName
The Amplify environment name for the pull request.
- Returns:
- The Amplify environment name for the pull request.
-
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
The backend for a
Branch
of an Amplify app. Use for a backend created from an CloudFormation stack.- Returns:
- The backend for a
Branch
of an Amplify app. Use for a backend created from an CloudFormation stack.
-
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<CreateBranchRequest.Builder,
CreateBranchRequest> - Specified by:
toBuilder
in classAmplifyRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-