BookingAppointment (odata-client-msgraph-beta 0.1.17 API)

java.lang.Object
- odata.msgraph.client.beta.entity.Entity
- - odata.msgraph.client.beta.entity.BookingAppointment

All Implemented Interfaces:

com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType
```
public class BookingAppointment
extends Entity
implements com.github.davidmoten.odata.client.ODataEntityType
```
“Represents a booked appointment of a service by a customer in a business.”

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BookingAppointment.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`BookingAppointment.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`customerEmailAddress`
`protected String`	`customerId`
`protected Location`	`customerLocation`
`protected String`	`customerName`
`protected String`	`customerNotes`
`protected String`	`customerPhone`
`protected Duration`	`duration`
`protected DateTimeTimeZone`	`end`
`protected Double`	`invoiceAmount`
`protected DateTimeTimeZone`	`invoiceDate`
`protected String`	`invoiceId`
`protected BookingInvoiceStatus`	`invoiceStatus`
`protected String`	`invoiceUrl`
`protected Boolean`	`optOutOfCustomerEmail`
`protected Duration`	`postBuffer`
`protected Duration`	`preBuffer`
`protected Double`	`price`
`protected BookingPriceType`	`priceType`
`protected List<BookingReminder>`	`reminders`
`protected String`	`remindersNextLink`
`protected String`	`selfServiceAppointmentId`
`protected String`	`serviceId`
`protected Location`	`serviceLocation`
`protected String`	`serviceName`
`protected String`	`serviceNotes`
`protected List<String>`	`staffMemberIds`
`protected String`	`staffMemberIdsNextLink`
`protected DateTimeTimeZone`	`start`

Fields inherited from class odata.msgraph.client.beta.entity.Entity
changedFields, contextPath, id, odataType, unmappedFields

Constructor Summary

Constructors
Modifier Constructor and Description

protected BookingAppointment()

Constructors
Modifier	Constructor and Description
`protected`	`BookingAppointment()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BookingAppointment.Builder`	`builderBookingAppointment()` Returns a builder which is used to create a new instance of this class (given that this class is immutable).
`com.github.davidmoten.odata.client.ActionRequestNoReturn`	`cancel(String cancellationMessage)`
`com.github.davidmoten.odata.client.internal.ChangedFields`	`getChangedFields()`
`Optional<String>`	`getCustomerEmailAddress()`
`Optional<String>`	`getCustomerId()` “If CustomerId is not specified when an appointment is created then a new customer is created based on the appointment customer information.
`Optional<Location>`	`getCustomerLocation()`
`Optional<String>`	`getCustomerName()`
`Optional<String>`	`getCustomerNotes()` “The value of this property is only available when reading an individual booking appointment by id.
`Optional<String>`	`getCustomerPhone()`
`Optional<Duration>`	`getDuration()` Org.OData.Core.V1.Computed
`Optional<DateTimeTimeZone>`	`getEnd()`
`Optional<Double>`	`getInvoiceAmount()`
`Optional<DateTimeTimeZone>`	`getInvoiceDate()`
`Optional<String>`	`getInvoiceId()`
`Optional<BookingInvoiceStatus>`	`getInvoiceStatus()`
`Optional<String>`	`getInvoiceUrl()` Org.OData.Core.V1.IsURL
`Optional<Boolean>`	`getOptOutOfCustomerEmail()`
`Optional<Duration>`	`getPostBuffer()`
`Optional<Duration>`	`getPreBuffer()`
`Optional<Double>`	`getPrice()`
`Optional<BookingPriceType>`	`getPriceType()`
`com.github.davidmoten.odata.client.CollectionPage<BookingReminder>`	`getReminders()` “The value of this property is only available when reading an individual booking appointment by id.”
`Optional<String>`	`getSelfServiceAppointmentId()`
`Optional<String>`	`getServiceId()` “The id of the booking service associated with this appointment.”
`Optional<Location>`	`getServiceLocation()`
`Optional<String>`	`getServiceName()` “This property is optional when creating a new appointment.
`Optional<String>`	`getServiceNotes()` “The value of this property is only available when reading an individual booking appointment by id.”
`com.github.davidmoten.odata.client.CollectionPage<String>`	`getStaffMemberIds()`
`Optional<DateTimeTimeZone>`	`getStart()`
`com.github.davidmoten.odata.client.internal.UnmappedFields`	`getUnmappedFields()`
`String`	`odataTypeName()`
`BookingAppointment`	`patch()` Submits only changed fields for update and returns an immutable copy of `this` with changed fields reset.
`void`	`postInject(boolean addKeysToContextPath)`
`BookingAppointment`	`put()` Submits all fields for update and returns an immutable copy of `this` with changed fields reset (they were ignored anyway).
`String`	`toString()`
`BookingAppointment`	`withCustomerEmailAddress(String customerEmailAddress)`
`BookingAppointment`	`withCustomerId(String customerId)` Returns an immutable copy of `this` with just the `customerId` field changed.
`BookingAppointment`	`withCustomerLocation(Location customerLocation)`
`BookingAppointment`	`withCustomerName(String customerName)`
`BookingAppointment`	`withCustomerNotes(String customerNotes)` Returns an immutable copy of `this` with just the `customerNotes` field changed.
`BookingAppointment`	`withCustomerPhone(String customerPhone)`
`BookingAppointment`	`withDuration(Duration duration)` Returns an immutable copy of `this` with just the `duration` field changed.
`BookingAppointment`	`withEnd(DateTimeTimeZone end)`
`BookingAppointment`	`withInvoiceAmount(Double invoiceAmount)`
`BookingAppointment`	`withInvoiceDate(DateTimeTimeZone invoiceDate)`
`BookingAppointment`	`withInvoiceId(String invoiceId)`
`BookingAppointment`	`withInvoiceStatus(BookingInvoiceStatus invoiceStatus)`
`BookingAppointment`	`withInvoiceUrl(String invoiceUrl)` Returns an immutable copy of `this` with just the `invoiceUrl` field changed.
`BookingAppointment`	`withOptOutOfCustomerEmail(Boolean optOutOfCustomerEmail)`
`BookingAppointment`	`withPostBuffer(Duration postBuffer)`
`BookingAppointment`	`withPreBuffer(Duration preBuffer)`
`BookingAppointment`	`withPrice(Double price)`
`BookingAppointment`	`withPriceType(BookingPriceType priceType)`
`BookingAppointment`	`withSelfServiceAppointmentId(String selfServiceAppointmentId)`
`BookingAppointment`	`withServiceId(String serviceId)` Returns an immutable copy of `this` with just the `serviceId` field changed.
`BookingAppointment`	`withServiceLocation(Location serviceLocation)`
`BookingAppointment`	`withServiceName(String serviceName)` Returns an immutable copy of `this` with just the `serviceName` field changed.
`BookingAppointment`	`withServiceNotes(String serviceNotes)` Returns an immutable copy of `this` with just the `serviceNotes` field changed.
`BookingAppointment`	`withStart(DateTimeTimeZone start)`

Methods inherited from class odata.msgraph.client.beta.entity.Entity
getId, withId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - selfServiceAppointmentId
```
protected String selfServiceAppointmentId
```
  - customerId
```
protected String customerId
```
  - customerName
```
protected String customerName
```
  - customerEmailAddress
```
protected String customerEmailAddress
```
  - customerPhone
```
protected String customerPhone
```
  - customerLocation
```
protected Location customerLocation
```
  - customerNotes
```
protected String customerNotes
```
  - serviceId
```
protected String serviceId
```
  - serviceName
```
protected String serviceName
```
  - start
```
protected DateTimeTimeZone start
```
  - end
```
protected DateTimeTimeZone end
```
  - duration
```
protected Duration duration
```
  - preBuffer
```
protected Duration preBuffer
```
  - postBuffer
```
protected Duration postBuffer
```
  - serviceLocation
```
protected Location serviceLocation
```
  - priceType
```
protected BookingPriceType priceType
```
  - price
```
protected Double price
```
  - serviceNotes
```
protected String serviceNotes
```
  - reminders
```
protected List<BookingReminder> reminders
```
  - remindersNextLink
```
protected String remindersNextLink
```
  - optOutOfCustomerEmail
```
protected Boolean optOutOfCustomerEmail
```
  - staffMemberIds
```
protected List<String> staffMemberIds
```
  - staffMemberIdsNextLink
```
protected String staffMemberIdsNextLink
```
  - invoiceAmount
```
protected Double invoiceAmount
```
  - invoiceDate
```
protected DateTimeTimeZone invoiceDate
```
  - invoiceId
```
protected String invoiceId
```
  - invoiceStatus
```
protected BookingInvoiceStatus invoiceStatus
```
  - invoiceUrl
```
protected String invoiceUrl
```
- Constructor Detail
  - BookingAppointment
```
protected BookingAppointment()
```
- Method Detail
  - odataTypeName
```
public String odataTypeName()
```
    Specified by:
    
    odataTypeName in interface com.github.davidmoten.odata.client.ODataType
    
    Overrides:
    
    odataTypeName in class Entity
  - builderBookingAppointment
```
public static BookingAppointment.Builder builderBookingAppointment()
```
    Returns a builder which is used to create a new instance of this class (given that this class is immutable).
    
    Returns:
    
    a new Builder for this class
  - getChangedFields
```
public com.github.davidmoten.odata.client.internal.ChangedFields getChangedFields()
```
    Specified by:
    
    getChangedFields in interface com.github.davidmoten.odata.client.ODataEntityType
    
    Overrides:
    
    getChangedFields in class Entity
  - postInject
```
public void postInject(boolean addKeysToContextPath)
```
    Specified by:
    
    postInject in interface com.github.davidmoten.odata.client.ODataType
    
    Overrides:
    
    postInject in class Entity
  - getSelfServiceAppointmentId
```
public Optional<String> getSelfServiceAppointmentId()
```
  - withSelfServiceAppointmentId
```
public BookingAppointment withSelfServiceAppointmentId(String selfServiceAppointmentId)
```
  - getCustomerId
```
public Optional<String> getCustomerId()
```
    “If CustomerId is not specified when an appointment is created then a new customer is created based on the appointment customer information. Once set, the customerId should be considered immutable.”
    
    Returns:
    
    property customerId
  - withCustomerId
```
public BookingAppointment withCustomerId(String customerId)
```
    Returns an immutable copy of this with just the customerId field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.
    “If CustomerId is not specified when an appointment is created then a new customer is created based on the appointment customer information. Once set, the customerId should be considered immutable.”
    
    Parameters:
    
    customerId - new value of customerId field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the customerId field changed
  - getCustomerName
```
public Optional<String> getCustomerName()
```
  - withCustomerName
```
public BookingAppointment withCustomerName(String customerName)
```
  - getCustomerEmailAddress
```
public Optional<String> getCustomerEmailAddress()
```
  - withCustomerEmailAddress
```
public BookingAppointment withCustomerEmailAddress(String customerEmailAddress)
```
  - getCustomerPhone
```
public Optional<String> getCustomerPhone()
```
  - withCustomerPhone
```
public BookingAppointment withCustomerPhone(String customerPhone)
```
  - getCustomerLocation
```
public Optional<Location> getCustomerLocation()
```
  - withCustomerLocation
```
public BookingAppointment withCustomerLocation(Location customerLocation)
```
  - getCustomerNotes
```
public Optional<String> getCustomerNotes()
```
    “The value of this property is only available when reading an individual booking appointment by id. Its value can only be set when creating a new appointment with a new customer, ie, without specifying a CustomerId. After that, the property is computed from the customer represented by CustomerId.”
    Org.OData.Core.V1.Immutable
    true
    
    Returns:
    
    property customerNotes
  - withCustomerNotes
```
public BookingAppointment withCustomerNotes(String customerNotes)
```
    Returns an immutable copy of this with just the customerNotes field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.
    “The value of this property is only available when reading an individual booking appointment by id. Its value can only be set when creating a new appointment with a new customer, ie, without specifying a CustomerId. After that, the property is computed from the customer represented by CustomerId.”
    Org.OData.Core.V1.Immutable
    true
    
    Parameters:
    
    customerNotes - new value of customerNotes field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the customerNotes field changed
  - getServiceId
```
public Optional<String> getServiceId()
```
    “The id of the booking service associated with this appointment.”
    Org.OData.Core.V1.Immutable
    true
    
    Returns:
    
    property serviceId
  - withServiceId
```
public BookingAppointment withServiceId(String serviceId)
```
    Returns an immutable copy of this with just the serviceId field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.
    “The id of the booking service associated with this appointment.”
    Org.OData.Core.V1.Immutable
    true
    
    Parameters:
    
    serviceId - new value of serviceId field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the serviceId field changed
  - getServiceName
```
public Optional<String> getServiceName()
```
    “This property is optional when creating a new appointment. If not specified, it is computed from the service associated with the appointment by the service id.”
    
    Returns:
    
    property serviceName
  - withServiceName
```
public BookingAppointment withServiceName(String serviceName)
```
    Returns an immutable copy of this with just the serviceName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.
    “This property is optional when creating a new appointment. If not specified, it is computed from the service associated with the appointment by the service id.”
    
    Parameters:
    
    serviceName - new value of serviceName field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the serviceName field changed
  - getStart
```
public Optional<DateTimeTimeZone> getStart()
```
  - withStart
```
public BookingAppointment withStart(DateTimeTimeZone start)
```
  - getEnd
```
public Optional<DateTimeTimeZone> getEnd()
```
  - withEnd
```
public BookingAppointment withEnd(DateTimeTimeZone end)
```
  - getDuration
```
public Optional<Duration> getDuration()
```
    Org.OData.Core.V1.Computed
    true
    
    Returns:
    
    property duration
  - withDuration
```
public BookingAppointment withDuration(Duration duration)
```
    Returns an immutable copy of this with just the duration field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.
    Org.OData.Core.V1.Computed
    true
    
    Parameters:
    
    duration - new value of duration field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the duration field changed
  - getPreBuffer
```
public Optional<Duration> getPreBuffer()
```
  - withPreBuffer
```
public BookingAppointment withPreBuffer(Duration preBuffer)
```
  - getPostBuffer
```
public Optional<Duration> getPostBuffer()
```
  - withPostBuffer
```
public BookingAppointment withPostBuffer(Duration postBuffer)
```
  - getServiceLocation
```
public Optional<Location> getServiceLocation()
```
  - withServiceLocation
```
public BookingAppointment withServiceLocation(Location serviceLocation)
```
  - getPriceType
```
public Optional<BookingPriceType> getPriceType()
```
  - withPriceType
```
public BookingAppointment withPriceType(BookingPriceType priceType)
```
  - getPrice
```
public Optional<Double> getPrice()
```
  - withPrice
```
public BookingAppointment withPrice(Double price)
```
  - getServiceNotes
```
public Optional<String> getServiceNotes()
```
    “The value of this property is only available when reading an individual booking appointment by id.”
    
    Returns:
    
    property serviceNotes
  - withServiceNotes
```
public BookingAppointment withServiceNotes(String serviceNotes)
```
    Returns an immutable copy of this with just the serviceNotes field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.
    “The value of this property is only available when reading an individual booking appointment by id.”
    
    Parameters:
    
    serviceNotes - new value of serviceNotes field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the serviceNotes field changed
  - getReminders
```
public com.github.davidmoten.odata.client.CollectionPage<BookingReminder> getReminders()
```
    “The value of this property is only available when reading an individual booking appointment by id.”
    
    Returns:
    
    property reminders
  - getOptOutOfCustomerEmail
```
public Optional<Boolean> getOptOutOfCustomerEmail()
```
  - withOptOutOfCustomerEmail
```
public BookingAppointment withOptOutOfCustomerEmail(Boolean optOutOfCustomerEmail)
```
  - getStaffMemberIds
```
public com.github.davidmoten.odata.client.CollectionPage<String> getStaffMemberIds()
```
  - getInvoiceAmount
```
public Optional<Double> getInvoiceAmount()
```
  - withInvoiceAmount
```
public BookingAppointment withInvoiceAmount(Double invoiceAmount)
```
  - getInvoiceDate
```
public Optional<DateTimeTimeZone> getInvoiceDate()
```
  - withInvoiceDate
```
public BookingAppointment withInvoiceDate(DateTimeTimeZone invoiceDate)
```
  - getInvoiceId
```
public Optional<String> getInvoiceId()
```
  - withInvoiceId
```
public BookingAppointment withInvoiceId(String invoiceId)
```
  - getInvoiceStatus
```
public Optional<BookingInvoiceStatus> getInvoiceStatus()
```
  - withInvoiceStatus
```
public BookingAppointment withInvoiceStatus(BookingInvoiceStatus invoiceStatus)
```
  - getInvoiceUrl
```
public Optional<String> getInvoiceUrl()
```
    Org.OData.Core.V1.IsURL
    true
    
    Returns:
    
    property invoiceUrl
  - withInvoiceUrl
```
public BookingAppointment withInvoiceUrl(String invoiceUrl)
```
    Returns an immutable copy of this with just the invoiceUrl field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.
    Org.OData.Core.V1.IsURL
    true
    
    Parameters:
    
    invoiceUrl - new value of invoiceUrl field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the invoiceUrl field changed
  - getUnmappedFields
```
public com.github.davidmoten.odata.client.internal.UnmappedFields getUnmappedFields()
```
    Specified by:
    
    getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
    
    Overrides:
    
    getUnmappedFields in class Entity
  - patch
```
public BookingAppointment patch()
```
    Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
    
    Overrides:
    
    patch in class Entity
    
    Returns:
    
    a copy of this with changed fields reset
    
    Throws:
    
    com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected
  - put
```
public BookingAppointment put()
```
    Submits all fields for update and returns an immutable copy of this with changed fields reset (they were ignored anyway).
    
    Overrides:
    
    put in class Entity
    
    Returns:
    
    a copy of this with changed fields reset
    
    Throws:
    
    com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected
  - cancel
```
public com.github.davidmoten.odata.client.ActionRequestNoReturn cancel(String cancellationMessage)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Entity

Class BookingAppointment

Nested Class Summary

Field Summary

Fields inherited from class odata.msgraph.client.beta.entity.Entity

Constructor Summary

Method Summary

Methods inherited from class odata.msgraph.client.beta.entity.Entity

Methods inherited from class java.lang.Object

Field Detail

selfServiceAppointmentId

customerId

customerName

customerEmailAddress

customerPhone

customerLocation

customerNotes

serviceId

serviceName

start

end

duration

preBuffer

postBuffer

serviceLocation

priceType

price

serviceNotes

reminders

remindersNextLink

optOutOfCustomerEmail

staffMemberIds

staffMemberIdsNextLink

invoiceAmount

invoiceDate

invoiceId

invoiceStatus

invoiceUrl

Constructor Detail

BookingAppointment

Method Detail

odataTypeName

builderBookingAppointment

getChangedFields

postInject

getSelfServiceAppointmentId

withSelfServiceAppointmentId

getCustomerId

withCustomerId

getCustomerName

withCustomerName

getCustomerEmailAddress

withCustomerEmailAddress

getCustomerPhone

withCustomerPhone

getCustomerLocation

withCustomerLocation

getCustomerNotes

withCustomerNotes

getServiceId

withServiceId

getServiceName

withServiceName

getStart

withStart

getEnd

withEnd

getDuration

withDuration

getPreBuffer

withPreBuffer

getPostBuffer

withPostBuffer

getServiceLocation

withServiceLocation

getPriceType

withPriceType

getPrice

withPrice

getServiceNotes

withServiceNotes