Class SyncConfiguration

java.lang.Object
software.amazon.awssdk.services.codeconnections.model.SyncConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SyncConfiguration.Builder,SyncConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class SyncConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SyncConfiguration.Builder,SyncConfiguration>

Information, such as repository, branch, provider, and resource names for a specific sync configuration.

See Also:

  • Method Details

    • branch

      public final String branch()

      The branch associated with a specific sync configuration.

      Returns:
      The branch associated with a specific sync configuration.

    • configFile

      public final String configFile()

      The file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.

      Returns:
      The file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.

    • ownerId

      public final String ownerId()

      The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

      Returns:
      The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

    • providerType

      public final ProviderType providerType()

      The connection provider type associated with a specific sync configuration, such as GitHub.

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

      Returns:
      The connection provider type associated with a specific sync configuration, such as GitHub.
      See Also:

    • providerTypeAsString

      public final String providerTypeAsString()

      The connection provider type associated with a specific sync configuration, such as GitHub.

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

      Returns:
      The connection provider type associated with a specific sync configuration, such as GitHub.
      See Also:

    • repositoryLinkId

      public final String repositoryLinkId()

      The ID of the repository link associated with a specific sync configuration.

      Returns:
      The ID of the repository link associated with a specific sync configuration.

    • repositoryName

      public final String repositoryName()

      The name of the repository associated with a specific sync configuration.

      Returns:
      The name of the repository associated with a specific sync configuration.

    • resourceName

      public final String resourceName()

      The name of the connection resource associated with a specific sync configuration.

      Returns:
      The name of the connection resource associated with a specific sync configuration.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

    • syncType

      public final SyncConfigurationType syncType()

      The type of sync for a specific 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 for a specific sync configuration.
      See Also:

    • syncTypeAsString

      public final String syncTypeAsString()

      The type of sync for a specific 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 for a specific 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 SyncConfiguration.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<SyncConfiguration.Builder,SyncConfiguration>
      Returns:
      a builder for type T

    • builder

      public static SyncConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SyncConfiguration.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)
      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)

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.