java.lang.Object
- com.softlayer.api.Type
- - com.softlayer.api.service.Entity
  - - com.softlayer.api.service.provisioning.Hook

```
@ApiType("SoftLayer_Provisioning_Hook")
public class Hook
extends Entity
```
The SoftLayer_Provisioning_Hook contains all the information needed to add a hook into a server/Virtual provision and os reload.

See Also:

SoftLayer_Provisioning_Hook

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Hook.Mask

static interface Hook.Service

static interface Hook.ServiceAsync

Field Summary

Fields
Modifier and Type	Field	Description
`protected Account`	`account`
`protected Long`	`accountId`	The ID of the account the script belongs to.
`protected boolean`	`accountIdSpecified`
`protected GregorianCalendar`	`createDate`
`protected boolean`	`createDateSpecified`
`protected Type`	`hookType`
`protected Long`	`id`
`protected boolean`	`idSpecified`
`protected GregorianCalendar`	`modifyDate`
`protected boolean`	`modifyDateSpecified`
`protected String`	`name`	The name of the hook.
`protected boolean`	`nameSpecified`
`protected Long`	`typeId`	The ID of the type of hook the script is identified as.
`protected boolean`	`typeIdSpecified`
`protected String`	`uri`	The endpoint that the script will be downloaded from (USERNAME AND PASSWORD SHOULD BE INCLUDED HERE).
`protected boolean`	`uriSpecified`

Fields inherited from class com.softlayer.api.Type
unknownProperties

Constructor Summary

Constructors
Constructor Description

Hook()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Hook.Service`	`asService(ApiClient client)`
`Account`	`getAccount()`
`Long`	`getAccountId()`
`GregorianCalendar`	`getCreateDate()`
`Type`	`getHookType()`
`Long`	`getId()`
`GregorianCalendar`	`getModifyDate()`
`String`	`getName()`
`Long`	`getTypeId()`
`String`	`getUri()`
`boolean`	`isAccountIdSpecified()`
`boolean`	`isCreateDateSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isModifyDateSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isTypeIdSpecified()`
`boolean`	`isUriSpecified()`
`static Hook.Service`	`service(ApiClient client)`
`static Hook.Service`	`service(ApiClient client, Long id)`
`void`	`setAccount(Account account)`
`void`	`setAccountId(Long accountId)`
`void`	`setCreateDate(GregorianCalendar createDate)`
`void`	`setHookType(Type hookType)`
`void`	`setId(Long id)`
`void`	`setModifyDate(GregorianCalendar modifyDate)`
`void`	`setName(String name)`
`void`	`setTypeId(Long typeId)`
`void`	`setUri(String uri)`
`void`	`unsetAccountId()`
`void`	`unsetCreateDate()`
`void`	`unsetId()`
`void`	`unsetModifyDate()`
`void`	`unsetName()`
`void`	`unsetTypeId()`
`void`	`unsetUri()`

Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties

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

Field Detail

account
```
@ApiProperty
protected Account account
```

hookType
```
@ApiProperty
protected Type hookType
```

accountId

@ApiProperty(canBeNullOrNotSet=true)
protected Long accountId

The ID of the account the script belongs to.

accountIdSpecified
```
protected boolean accountIdSpecified
```

createDate

@ApiProperty(canBeNullOrNotSet=true)
protected GregorianCalendar createDate

createDateSpecified
```
protected boolean createDateSpecified
```

id

@ApiProperty(canBeNullOrNotSet=true)
protected Long id

idSpecified
```
protected boolean idSpecified
```

modifyDate

@ApiProperty(canBeNullOrNotSet=true)
protected GregorianCalendar modifyDate

modifyDateSpecified
```
protected boolean modifyDateSpecified
```

name

@ApiProperty(canBeNullOrNotSet=true)
protected String name

The name of the hook.

nameSpecified
```
protected boolean nameSpecified
```

typeId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long typeId
```
The ID of the type of hook the script is identified as. Currently only CUSTOMER_PROVIDED_HOOK has been implemented.

typeIdSpecified
```
protected boolean typeIdSpecified
```

uri
```
@ApiProperty(canBeNullOrNotSet=true)
protected String uri
```
The endpoint that the script will be downloaded from (USERNAME AND PASSWORD SHOULD BE INCLUDED HERE). If the endpoint is HTTP, the script will only be downloaded. If the endpoint is HTTPS, the script will be downloaded and executed.

uriSpecified
```
protected boolean uriSpecified
```

Constructor Detail
- Hook
```
public Hook()
```

Method Detail

getAccount
```
public Account getAccount()
```

setAccount

public void setAccount(Account account)

getHookType
```
public Type getHookType()
```

setHookType

public void setHookType(Type hookType)

getAccountId
```
public Long getAccountId()
```

setAccountId

public void setAccountId(Long accountId)

isAccountIdSpecified
```
public boolean isAccountIdSpecified()
```

unsetAccountId
```
public void unsetAccountId()
```

getCreateDate

public GregorianCalendar getCreateDate()

setCreateDate

public void setCreateDate(GregorianCalendar createDate)

isCreateDateSpecified

public boolean isCreateDateSpecified()

unsetCreateDate
```
public void unsetCreateDate()
```

getId
```
public Long getId()
```

setId
```
public void setId(Long id)
```

isIdSpecified
```
public boolean isIdSpecified()
```

unsetId
```
public void unsetId()
```

getModifyDate

public GregorianCalendar getModifyDate()

setModifyDate

public void setModifyDate(GregorianCalendar modifyDate)

isModifyDateSpecified

public boolean isModifyDateSpecified()

unsetModifyDate
```
public void unsetModifyDate()
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

isNameSpecified
```
public boolean isNameSpecified()
```

unsetName
```
public void unsetName()
```

getTypeId
```
public Long getTypeId()
```

setTypeId

public void setTypeId(Long typeId)

isTypeIdSpecified
```
public boolean isTypeIdSpecified()
```

unsetTypeId
```
public void unsetTypeId()
```

getUri
```
public String getUri()
```

setUri
```
public void setUri(String uri)
```

isUriSpecified
```
public boolean isUriSpecified()
```

unsetUri
```
public void unsetUri()
```

asService

public Hook.Service asService(ApiClient client)

service

public static Hook.Service service(ApiClient client)

service

public static Hook.Service service(ApiClient client,
                                   Long id)

Modifier and Type	Class	Description
`static class`	`Hook.Mask`
`static interface`	`Hook.Service`
`static interface`	`Hook.ServiceAsync`

Class Hook

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Detail

account

hookType

accountId

accountIdSpecified

createDate

createDateSpecified

id

idSpecified

modifyDate

modifyDateSpecified

name

nameSpecified

typeId

typeIdSpecified

uri

uriSpecified

Constructor Detail

Hook

Method Detail

getAccount

setAccount

getHookType

setHookType

getAccountId

setAccountId

isAccountIdSpecified

unsetAccountId

getCreateDate

setCreateDate

isCreateDateSpecified

unsetCreateDate

getId

setId

isIdSpecified

unsetId

getModifyDate

setModifyDate

isModifyDateSpecified

unsetModifyDate

getName

setName

isNameSpecified

unsetName

getTypeId

setTypeId

isTypeIdSpecified

unsetTypeId

getUri

setUri

isUriSpecified

unsetUri

asService

service

service