Class CreateWebhookRequest

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

  • Method Details

    • projectName

      public final String projectName()

      The name of the CodeBuild project.

      Returns:
      The name of the CodeBuild project.

    • branchFilter

      public final String branchFilter()

      A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

      It is recommended that you use filterGroups instead of branchFilter.

      Returns:
      A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

      It is recommended that you use filterGroups instead of branchFilter.

    • hasFilterGroups

      public final boolean hasFilterGroups()
      For responses, this returns true if the service returned a value for the FilterGroups 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.

    • filterGroups

      public final List<List<WebhookFilter>> filterGroups()

      An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

      For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

      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 hasFilterGroups() method.

      Returns:
      An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

      For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

    • buildType

      public final WebhookBuildType buildType()

      Specifies the type of build this webhook will trigger.

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

      Returns:
      Specifies the type of build this webhook will trigger.
      See Also:

    • buildTypeAsString

      public final String buildTypeAsString()

      Specifies the type of build this webhook will trigger.

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

      Returns:
      Specifies the type of build this webhook will trigger.
      See Also:

    • manualCreation

      public final Boolean manualCreation()

      If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

      manualCreation is only available for GitHub webhooks.

      Returns:
      If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

      manualCreation is only available for GitHub webhooks.

    • scopeConfiguration

      public final ScopeConfiguration scopeConfiguration()

      The scope configuration for global or organization webhooks.

      Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

      Returns:
      The scope configuration for global or organization webhooks.

      Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

    • toBuilder

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

    • builder

      public static CreateWebhookRequest.Builder builder()

    • serializableBuilderClass

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