Class CreateSyncConfigurationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.codeconnections.model.CodeConnectionsRequest
software.amazon.awssdk.services.codeconnections.model.CreateSyncConfigurationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateSyncConfigurationRequest.Builder,CreateSyncConfigurationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateSyncConfigurationRequest extends CodeConnectionsRequest implements ToCopyableBuilder<CreateSyncConfigurationRequest.Builder,CreateSyncConfigurationRequest>

  • Method Details

    • branch

      public final String branch()

      The branch in the repository from which changes will be synced.

      Returns:
      The branch in the repository from which changes will be synced.

    • configFile

      public final String configFile()

      The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.

      Returns:
      The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.

    • repositoryLinkId

      public final String repositoryLinkId()

      The ID of the repository link created for the connection. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.

      Returns:
      The ID of the repository link created for the connection. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.

    • resourceName

      public final String resourceName()

      The name of the Amazon Web Services resource (for example, a CloudFormation stack in the case of CFN_STACK_SYNC) that will be synchronized from the linked repository.

      Returns:
      The name of the Amazon Web Services resource (for example, a CloudFormation stack in the case of CFN_STACK_SYNC) that will be synchronized from the linked repository.

    • roleArn

      public final String roleArn()

      The ARN of the IAM role that grants permission for Amazon Web Services to use Git sync to update a given Amazon Web Services resource on your behalf.

      Returns:
      The ARN of the IAM role that grants permission for Amazon Web Services to use Git sync to update a given Amazon Web Services resource on your behalf.

    • syncType

      public final SyncConfigurationType syncType()

      The type of sync configuration.

      If the service returns an enum value that is not available in the current SDK version, syncType will return SyncConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from syncTypeAsString().

      Returns:
      The type of sync configuration.
      See Also:

    • syncTypeAsString

      public final String syncTypeAsString()

      The type of sync configuration.

      If the service returns an enum value that is not available in the current SDK version, syncType will return SyncConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from syncTypeAsString().

      Returns:
      The type of sync configuration.
      See Also:

    • publishDeploymentStatus

      public final PublishDeploymentStatus publishDeploymentStatus()

      Whether to enable or disable publishing of deployment status to source providers.

      If the service returns an enum value that is not available in the current SDK version, publishDeploymentStatus will return PublishDeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publishDeploymentStatusAsString().

      Returns:
      Whether to enable or disable publishing of deployment status to source providers.
      See Also:

    • publishDeploymentStatusAsString

      public final String publishDeploymentStatusAsString()

      Whether to enable or disable publishing of deployment status to source providers.

      If the service returns an enum value that is not available in the current SDK version, publishDeploymentStatus will return PublishDeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publishDeploymentStatusAsString().

      Returns:
      Whether to enable or disable publishing of deployment status to source providers.
      See Also:

    • triggerResourceUpdateOn

      public final TriggerResourceUpdateOn triggerResourceUpdateOn()

      When to trigger Git sync to begin the stack update.

      If the service returns an enum value that is not available in the current SDK version, triggerResourceUpdateOn will return TriggerResourceUpdateOn.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from triggerResourceUpdateOnAsString().

      Returns:
      When to trigger Git sync to begin the stack update.
      See Also:

    • triggerResourceUpdateOnAsString

      public final String triggerResourceUpdateOnAsString()

      When to trigger Git sync to begin the stack update.

      If the service returns an enum value that is not available in the current SDK version, triggerResourceUpdateOn will return TriggerResourceUpdateOn.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from triggerResourceUpdateOnAsString().

      Returns:
      When to trigger Git sync to begin the stack update.
      See Also:

    • pullRequestComment

      public final PullRequestComment pullRequestComment()

      A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.

      If the service returns an enum value that is not available in the current SDK version, pullRequestComment will return PullRequestComment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pullRequestCommentAsString().

      Returns:
      A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.
      See Also:

    • pullRequestCommentAsString

      public final String pullRequestCommentAsString()

      A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.

      If the service returns an enum value that is not available in the current SDK version, pullRequestComment will return PullRequestComment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pullRequestCommentAsString().

      Returns:
      A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.
      See Also:

    • toBuilder

      public CreateSyncConfigurationRequest.Builder 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 interface ToCopyableBuilder<CreateSyncConfigurationRequest.Builder,CreateSyncConfigurationRequest>
      Specified by:
      toBuilder in class CodeConnectionsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateSyncConfigurationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateSyncConfigurationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.