com.solidfire.element.api

Class CreateInitiator

java.lang.Object

com.solidfire.element.api.CreateInitiator

All Implemented Interfaces:

java.io.Serializable

public class CreateInitiator
extends java.lang.Object
implements java.io.Serializable

CreateInitiator Object containing characteristics of each new initiator to be created.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateInitiator.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
CreateInitiator()
CreateInitiator(java.lang.String name, Optional<java.lang.String> alias, Optional<java.lang.Long> volumeAccessGroupID, Optional<Attributes> attributes, Optional<java.lang.Boolean> requireChap, Optional<java.lang.String> chapUsername, Optional<CHAPSecret> initiatorSecret, Optional<CHAPSecret> targetSecret)
CreateInitiator(java.lang.String name, Optional<java.lang.String> alias, Optional<java.lang.Long> volumeAccessGroupID, Optional<Attributes> attributes, Optional<java.lang.Boolean> requireChap, Optional<java.lang.String> chapUsername, Optional<CHAPSecret> initiatorSecret, Optional<CHAPSecret> targetSecret, Optional<java.lang.Long[]> virtualNetworkIDs)

Method Summary

Modifier and Type	Method and Description
CreateInitiator.Builder	asBuilder()
static CreateInitiator.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<java.lang.String>	getAlias() The friendly name to assign to this initiator.
Optional<Attributes>	getAttributes() A set of JSON attributes assigned to this initiator.
Optional<java.lang.String>	getChapUsername() The CHAP username for this initiator.
Optional<CHAPSecret>	getInitiatorSecret() The CHAP secret used for authentication of the initiator.
java.lang.String	getName() The name of the initiator (IQN or WWPN) to create.
Optional<java.lang.Boolean>	getRequireChap() "requireChap" determines if the initiator is required to use CHAP during session login.
Optional<CHAPSecret>	getTargetSecret() The CHAP secret used for authentication of the target.
Optional<java.lang.Long[]>	getVirtualNetworkIDs() The list of virtual network identifiers associated with this initiator.
Optional<java.lang.Long>	getVolumeAccessGroupID() The ID of the volume access group to which this newly created initiator will be added.
int	hashCode()
void	setAlias(Optional<java.lang.String> alias)
void	setAttributes(Optional<Attributes> attributes)
void	setChapUsername(Optional<java.lang.String> chapUsername)
void	setInitiatorSecret(Optional<CHAPSecret> initiatorSecret)
void	setName(java.lang.String name)
void	setRequireChap(Optional<java.lang.Boolean> requireChap)
void	setTargetSecret(Optional<CHAPSecret> targetSecret)
void	setVirtualNetworkIDs(Optional<java.lang.Long[]> virtualNetworkIDs)
void	setVolumeAccessGroupID(Optional<java.lang.Long> volumeAccessGroupID)
java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

CreateInitiator

@Since(value="7.0")
public CreateInitiator()

CreateInitiator

@Since(value="7.0")
public CreateInitiator(java.lang.String name,
                                           Optional<java.lang.String> alias,
                                           Optional<java.lang.Long> volumeAccessGroupID,
                                           Optional<Attributes> attributes,
                                           Optional<java.lang.Boolean> requireChap,
                                           Optional<java.lang.String> chapUsername,
                                           Optional<CHAPSecret> initiatorSecret,
                                           Optional<CHAPSecret> targetSecret)

CreateInitiator

@Since(value="12.0")
public CreateInitiator(java.lang.String name,
                                            Optional<java.lang.String> alias,
                                            Optional<java.lang.Long> volumeAccessGroupID,
                                            Optional<Attributes> attributes,
                                            Optional<java.lang.Boolean> requireChap,
                                            Optional<java.lang.String> chapUsername,
                                            Optional<CHAPSecret> initiatorSecret,
                                            Optional<CHAPSecret> targetSecret,
                                            Optional<java.lang.Long[]> virtualNetworkIDs)

Method Detail

getName

public java.lang.String getName()

The name of the initiator (IQN or WWPN) to create.

setName

public void setName(java.lang.String name)

getAlias

public Optional<java.lang.String> getAlias()

The friendly name to assign to this initiator.

setAlias

public void setAlias(Optional<java.lang.String> alias)

getVolumeAccessGroupID

public Optional<java.lang.Long> getVolumeAccessGroupID()

The ID of the volume access group to which this newly created initiator will be added.

setVolumeAccessGroupID

public void setVolumeAccessGroupID(Optional<java.lang.Long> volumeAccessGroupID)

getAttributes

public Optional<Attributes> getAttributes()

A set of JSON attributes assigned to this initiator. (JSON Object)

setAttributes

public void setAttributes(Optional<Attributes> attributes)

getRequireChap

public Optional<java.lang.Boolean> getRequireChap()

"requireChap" determines if the initiator is required to use CHAP during session login. CHAP is optional if "requireChap" is false.

setRequireChap

public void setRequireChap(Optional<java.lang.Boolean> requireChap)

getChapUsername

public Optional<java.lang.String> getChapUsername()

The CHAP username for this initiator. Defaults to the initiator name (IQN) if not specified during creation and "requireChap" is true.

setChapUsername

public void setChapUsername(Optional<java.lang.String> chapUsername)

getInitiatorSecret

public Optional<CHAPSecret> getInitiatorSecret()

The CHAP secret used for authentication of the initiator. Defaults to a randomly generated secret if not specified during creation and "requireChap" is true.

setInitiatorSecret

public void setInitiatorSecret(Optional<CHAPSecret> initiatorSecret)

getTargetSecret

public Optional<CHAPSecret> getTargetSecret()

The CHAP secret used for authentication of the target. Defaults to a randomly generated secret if not specified during creation and "requireChap" is true.

setTargetSecret

public void setTargetSecret(Optional<CHAPSecret> targetSecret)

getVirtualNetworkIDs

public Optional<java.lang.Long[]> getVirtualNetworkIDs()

The list of virtual network identifiers associated with this initiator. If one or more are defined, this initiator will only be able to login to the specified virtual networks. If no virtual networks are defined this initiator can login to all networks.

setVirtualNetworkIDs

public void setVirtualNetworkIDs(Optional<java.lang.Long[]> virtualNetworkIDs)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static CreateInitiator.Builder builder()

asBuilder

public final CreateInitiator.Builder asBuilder()