Package com.spotify.github.v3.activity.events

Class ImmutableCreateEvent

  • All Implemented Interfaces:
    BaseEvent, CreateEvent
    @ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableCreateEvent
extends Object
implements CreateEvent
    Immutable implementation of CreateEvent.

    Use the builder to create immutable instances: ImmutableCreateEvent.builder().

    • Method Detail

      • sender

        @Nullable
public User sender()
        The User that triggered/sent the event.
        Specified by:
        sender in interface BaseEvent

      • ref

        @Nullable
public String ref()
        The git ref (or null if only a repository was created).
        Specified by:
        ref in interface CreateEvent

      • refType

        @Nullable
public String refType()
        The object that was created. Can be one of "repository", "branch", or "tag"
        Specified by:
        refType in interface CreateEvent

      • masterBranch

        @Nullable
public String masterBranch()
        The name of the repository's default branch (usually master).
        Specified by:
        masterBranch in interface CreateEvent

      • pusherType

        @Nullable
public String pusherType()
        No doc found on github - Usually is "user".
        Specified by:
        pusherType in interface CreateEvent

      • withRepository

        public final ImmutableCreateEvent withRepository​(@Nullable
                                                 Repository value)
        Copy the current immutable object by setting a value for the repository attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for repository (can be null)
        Returns:
        A modified copy of the this object

      • withSender

        public final ImmutableCreateEvent withSender​(@Nullable
                                             User value)
        Copy the current immutable object by setting a value for the sender attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for sender (can be null)
        Returns:
        A modified copy of the this object

      • withEventInstallation

        public final ImmutableCreateEvent withEventInstallation​(@Nullable
                                                        EventInstallation value)
        Copy the current immutable object by setting a value for the eventInstallation attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for eventInstallation (can be null)
        Returns:
        A modified copy of the this object

      • withRef

        public final ImmutableCreateEvent withRef​(@Nullable
                                          String value)
        Copy the current immutable object by setting a value for the ref attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for ref (can be null)
        Returns:
        A modified copy of the this object

      • withRefType

        public final ImmutableCreateEvent withRefType​(@Nullable
                                              String value)
        Copy the current immutable object by setting a value for the refType attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for refType (can be null)
        Returns:
        A modified copy of the this object

      • withMasterBranch

        public final ImmutableCreateEvent withMasterBranch​(@Nullable
                                                   String value)
        Copy the current immutable object by setting a value for the masterBranch attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for masterBranch (can be null)
        Returns:
        A modified copy of the this object

      • withDescription

        public final ImmutableCreateEvent withDescription​(String value)
        Copy the current immutable object by setting a present value for the optional description attribute.
        Parameters:
        value - The value for description
        Returns:
        A modified copy of this object

      • withDescription

        public final ImmutableCreateEvent withDescription​(Optional<String> optional)
        Copy the current immutable object by setting an optional value for the description attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for description
        Returns:
        A modified copy of this object

      • withPusherType

        public final ImmutableCreateEvent withPusherType​(@Nullable
                                                 String value)
        Copy the current immutable object by setting a value for the pusherType attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for pusherType (can be null)
        Returns:
        A modified copy of the this object

      • equals

        public boolean equals​(@Nullable
                      Object another)
        This instance is equal to all instances of ImmutableCreateEvent that have equal attribute values.
        Overrides:
        equals in class Object
        Returns:
        true if this is equal to another instance

      • hashCode

        public int hashCode()
        Computes a hash code from attributes: repository, sender, eventInstallation, ref, refType, masterBranch, description, pusherType.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

        public String toString()
        Prints the immutable value CreateEvent with attribute values.
        Overrides:
        toString in class Object
        Returns:
        A string representation of the value

      • copyOf

        public static ImmutableCreateEvent copyOf​(CreateEvent instance)
        Creates an immutable copy of a CreateEvent value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
        Parameters:
        instance - The instance to copy
        Returns:
        A copied immutable CreateEvent instance

      • builder

        public static ImmutableCreateEvent.Builder builder()
        Creates a builder for ImmutableCreateEvent. 
         ImmutableCreateEvent.builder()
    .repository(com.spotify.github.v3.repos.Repository | null) // nullable repository
    .sender(com.spotify.github.v3.User | null) // nullable sender
    .eventInstallation(com.spotify.github.v3.activity.events.EventInstallation | null) // nullable eventInstallation
    .ref(String | null) // nullable ref
    .refType(String | null) // nullable refType
    .masterBranch(String | null) // nullable masterBranch
    .description(String) // optional description
    .pusherType(String | null) // nullable pusherType
    .build();
        Returns:
        A new ImmutableCreateEvent builder