Class CreateClusterNetworkInterfaceOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.is.vpc.v1.model.CreateClusterNetworkInterfaceOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class CreateClusterNetworkInterfaceOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The createClusterNetworkInterface options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateClusterNetworkInterfaceOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
String	clusterNetworkId()	Gets the clusterNetworkId.
String	name()	Gets the name.
CreateClusterNetworkInterfaceOptions.Builder	newBuilder()	New builder.
ClusterNetworkInterfacePrimaryIPPrototype	primaryIp()	Gets the primaryIp.
ClusterNetworkSubnetIdentity	subnet()	Gets the subnet.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public CreateClusterNetworkInterfaceOptions.Builder newBuilder()

New builder.

Returns:

a CreateClusterNetworkInterfaceOptions builder

clusterNetworkId

public String clusterNetworkId()

Gets the clusterNetworkId. The cluster network identifier.

Returns:

the clusterNetworkId

name

public String name()

Gets the name. The name for this cluster network interface. The name must not be used by another interface in the cluster network. Names beginning with `ibm-` are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated list of randomly-selected words.

Returns:

the name

primaryIp

public ClusterNetworkInterfacePrimaryIPPrototype primaryIp()

Gets the primaryIp. The primary IP address to bind to the cluster network interface. May be either a cluster network subnet reserved IP identity, or a cluster network subnet reserved IP prototype object which will be used to create a new cluster network subnet reserved IP. If a cluster network subnet reserved IP identity is provided, the specified cluster network subnet reserved IP must be unbound. If a cluster network subnet reserved IP prototype object with an address is provided, the address must be available on the cluster network interface's cluster network subnet. If no address is specified, an available address on the cluster network subnet will be automatically selected and reserved.

Returns:

the primaryIp

subnet

public ClusterNetworkSubnetIdentity subnet()

Gets the subnet. The associated cluster network subnet. Required if `primary_ip` does not specify a cluster network subnet reserved IP identity.

Returns:

the subnet