com.squareup.square.models

Class SearchAvailabilityFilter

java.lang.Object

com.squareup.square.models.SearchAvailabilityFilter

public class SearchAvailabilityFilter
extends Object

This is a model class for SearchAvailabilityFilter type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchAvailabilityFilter.Builder Class to build instances of SearchAvailabilityFilter.

Constructor Summary

Constructors

Constructor and Description
SearchAvailabilityFilter(TimeRange startAtRange, String locationId, List<SegmentFilter> segmentFilters, String bookingId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBookingId() Getter for BookingId.
String	getLocationId() Getter for LocationId.
List<SegmentFilter>	getSegmentFilters() Getter for SegmentFilters.
TimeRange	getStartAtRange() Getter for StartAtRange.
int	hashCode()
SearchAvailabilityFilter.Builder	toBuilder() Builds a new SearchAvailabilityFilter.Builder object.
String	toString() Converts this SearchAvailabilityFilter into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchAvailabilityFilter

public SearchAvailabilityFilter(TimeRange startAtRange,
                                String locationId,
                                List<SegmentFilter> segmentFilters,
                                String bookingId)

Initialization constructor.

Parameters:

startAtRange - TimeRange value for startAtRange.

locationId - String value for locationId.

segmentFilters - List of SegmentFilter value for segmentFilters.

bookingId - String value for bookingId.

Method Detail

getStartAtRange

public TimeRange getStartAtRange()

Getter for StartAtRange. Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevant endpoint-specific documentation to determine how time ranges are handled.

Returns:

Returns the TimeRange

getLocationId

public String getLocationId()

Getter for LocationId. The query expression to search for buyer-accessible availabilities with their location IDs matching the specified location ID. This query expression cannot be set if `booking_id` is set.

Returns:

Returns the String

getSegmentFilters

public List<SegmentFilter> getSegmentFilters()

Getter for SegmentFilters. The query expression to search for buyer-accessible availabilities matching the specified list of segment filters. If the size of the `segment_filters` list is `n`, the search returns availabilities with `n` segments per availability. This query expression cannot be set if `booking_id` is set.

Returns:

Returns the List of SegmentFilter

getBookingId

public String getBookingId()

Getter for BookingId. The query expression to search for buyer-accessible availabilities for an existing booking by matching the specified `booking_id` value. This is commonly used to reschedule an appointment. If this expression is set, the `location_id` and `segment_filters` expressions cannot be set.

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this SearchAvailabilityFilter into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SearchAvailabilityFilter.Builder toBuilder()

Builds a new SearchAvailabilityFilter.Builder object. Creates the instance with the state of the current model.

Returns:

a new SearchAvailabilityFilter.Builder object