Class RepositoryTrigger
- java.lang.Object
-
- software.amazon.awssdk.services.codecommit.model.RepositoryTrigger
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RepositoryTrigger.Builder,RepositoryTrigger>
@Generated("software.amazon.awssdk:codegen") public final class RepositoryTrigger extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RepositoryTrigger.Builder,RepositoryTrigger>
Information about a trigger for a repository.
If you want to receive notifications about repository events, consider using notifications instead of triggers. For more information, see Configuring notifications for repository events.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRepositoryTrigger.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>branches()The branches to be included in the trigger configuration.static RepositoryTrigger.Builderbuilder()StringcustomData()Any custom data associated with the trigger to be included in the information sent to the target of the trigger.StringdestinationArn()The ARN of the resource that is the target for a trigger (for example, the ARN of a topic in Amazon SNS).booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<RepositoryTriggerEventEnum>events()The repository events that cause the trigger to run actions in another service, such as sending a notification through Amazon SNS.List<String>eventsAsStrings()The repository events that cause the trigger to run actions in another service, such as sending a notification through Amazon SNS.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasBranches()For responses, this returns true if the service returned a value for the Branches property.booleanhasEvents()For responses, this returns true if the service returned a value for the Events property.inthashCode()Stringname()The name of the trigger.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends RepositoryTrigger.Builder>serializableBuilderClass()RepositoryTrigger.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The name of the trigger.
- Returns:
- The name of the trigger.
-
destinationArn
public final String destinationArn()
The ARN of the resource that is the target for a trigger (for example, the ARN of a topic in Amazon SNS).
- Returns:
- The ARN of the resource that is the target for a trigger (for example, the ARN of a topic in Amazon SNS).
-
customData
public final String customData()
Any custom data associated with the trigger to be included in the information sent to the target of the trigger.
- Returns:
- Any custom data associated with the trigger to be included in the information sent to the target of the trigger.
-
hasBranches
public final boolean hasBranches()
For responses, this returns true if the service returned a value for the Branches 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.
-
branches
public final List<String> branches()
The branches to be included in the trigger configuration. If you specify an empty array, the trigger applies to all branches.
Although no content is required in the array, you must include the array itself.
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
hasBranches()method.- Returns:
- The branches to be included in the trigger configuration. If you specify an empty array, the trigger
applies to all branches.
Although no content is required in the array, you must include the array itself.
-
events
public final List<RepositoryTriggerEventEnum> events()
The repository events that cause the trigger to run actions in another service, such as sending a notification through Amazon SNS.
The valid value "all" cannot be used with any other values.
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
hasEvents()method.- Returns:
- The repository events that cause the trigger to run actions in another service, such as sending a
notification through Amazon SNS.
The valid value "all" cannot be used with any other values.
-
hasEvents
public final boolean hasEvents()
For responses, this returns true if the service returned a value for the Events 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.
-
eventsAsStrings
public final List<String> eventsAsStrings()
The repository events that cause the trigger to run actions in another service, such as sending a notification through Amazon SNS.
The valid value "all" cannot be used with any other values.
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
hasEvents()method.- Returns:
- The repository events that cause the trigger to run actions in another service, such as sending a
notification through Amazon SNS.
The valid value "all" cannot be used with any other values.
-
toBuilder
public RepositoryTrigger.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RepositoryTrigger.Builder,RepositoryTrigger>
-
builder
public static RepositoryTrigger.Builder builder()
-
serializableBuilderClass
public static Class<? extends RepositoryTrigger.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-