Class WebhookDefinition
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WebhookDefinition.Builder,
WebhookDefinition>
Represents information about a webhook and its definition.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionSupported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.final String
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.final WebhookAuthConfiguration
Properties that configure the authentication applied to incoming webhook trigger requests.static WebhookDefinition.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<WebhookFilterRule> filters()
A list of rules applied to the body/payload sent in the POST request to a webhook URL.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 Filters property.final int
hashCode()
final String
name()
The name of the webhook.static Class
<? extends WebhookDefinition.Builder> final String
The name of the action in a pipeline you want to connect to the webhook.final String
The name of the pipeline you want to connect to the webhook.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the webhook.
- Returns:
- The name of the webhook.
-
targetPipeline
The name of the pipeline you want to connect to the webhook.
- Returns:
- The name of the pipeline you want to connect to the webhook.
-
targetAction
The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
- Returns:
- The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
-
hasFilters
public final boolean hasFilters()For responses, this returns true if the service returned a value for the Filters 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. -
filters
A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
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
hasFilters()
method.- Returns:
- A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
-
authentication
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
-
For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
-
IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
-
UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
If the service returns an enum value that is not available in the current SDK version,
authentication
will returnWebhookAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationAsString()
.- Returns:
- Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
-
For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
-
IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
-
UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
-
- See Also:
-
-
authenticationAsString
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
-
For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
-
IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
-
UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
If the service returns an enum value that is not available in the current SDK version,
authentication
will returnWebhookAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationAsString()
.- Returns:
- Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
-
For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
-
IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
-
UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
-
- See Also:
-
-
authenticationConfiguration
Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the
SecretToken
property must be set. For IP, only theAllowedIPRange
property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.- Returns:
- Properties that configure the authentication applied to incoming webhook trigger requests. The required
properties depend on the authentication type. For GITHUB_HMAC, only the
SecretToken
property must be set. For IP, only theAllowedIPRange
property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
-
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<WebhookDefinition.Builder,
WebhookDefinition> - 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
-