Package com.ibm.cloud.networking.zones.v1

Class Zones

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.cloud.networking.zones.v1.Zones

public class Zones
extends com.ibm.cloud.sdk.core.service.BaseService

CIS Zones.

Version:

v1

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_SERVICE_NAME
static String	DEFAULT_SERVICE_URL

Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_ENABLE_RETRIES, PROPNAME_MAX_RETRIES, PROPNAME_RETRY_INTERVAL, PROPNAME_URL

Constructor Summary

Constructors

Constructor	Description
Zones(String crn, String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)	Constructs an instance of the `Zones` client.

Method Summary

Modifier and Type	Method	Description
com.ibm.cloud.sdk.core.http.ServiceCall<ZoneResp>	createZone()	Create zone.
com.ibm.cloud.sdk.core.http.ServiceCall<ZoneResp>	createZone(CreateZoneOptions createZoneOptions)	Create zone.
com.ibm.cloud.sdk.core.http.ServiceCall<DeleteZoneResp>	deleteZone(DeleteZoneOptions deleteZoneOptions)	Delete zone.
String	getCrn()	Gets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<ZoneResp>	getZone(GetZoneOptions getZoneOptions)	Get zone.
com.ibm.cloud.sdk.core.http.ServiceCall<ListZonesResp>	listZones()	List all zones.
com.ibm.cloud.sdk.core.http.ServiceCall<ListZonesResp>	listZones(ListZonesOptions listZonesOptions)	List all zones.
static Zones	newInstance(String crn)	Class method which constructs an instance of the `Zones` client.
static Zones	newInstance(String crn, String serviceName)	Class method which constructs an instance of the `Zones` client.
void	setCrn(String crn)	Sets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<ZoneResp>	updateZone(UpdateZoneOptions updateZoneOptions)	Update zone.
com.ibm.cloud.sdk.core.http.ServiceCall<ZoneActivationcheckResp>	zoneActivationCheck(ZoneActivationCheckOptions zoneActivationCheckOptions)	Check zone.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureService, constructServiceUrl, constructServiceURL, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, getDefaultHeaders, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, setClient, setDefaultHeaders, setEndPoint, setServiceUrl, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SERVICE_NAME

public static final String DEFAULT_SERVICE_NAME

See Also:

Constant Field Values

DEFAULT_SERVICE_URL

public static final String DEFAULT_SERVICE_URL

See Also:

Constant Field Values

Constructor Detail

Zones

public Zones(String crn,
             String serviceName,
             com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs an instance of the `Zones` client. The specified service name and authenticator are used to configure the client instance.

Parameters:

crn - Full url-encoded CRN of the service instance.

serviceName - the service name to be used when configuring the client instance

authenticator - the Authenticator instance to be configured for this client

Method Detail

newInstance

public static Zones newInstance(String crn)

Class method which constructs an instance of the `Zones` client. The default service name is used to configure the client instance.

Parameters:

crn - Full url-encoded CRN of the service instance.

Returns:

an instance of the `Zones` client using external configuration

newInstance

public static Zones newInstance(String crn,
                                String serviceName)

Class method which constructs an instance of the `Zones` client. The specified service name is used to configure the client instance.

Parameters:

crn - Full url-encoded CRN of the service instance.

serviceName - the service name to be used when configuring the client instance

Returns:

an instance of the `Zones` client using external configuration

getCrn

public String getCrn()

Gets the crn. Full url-encoded CRN of the service instance.

Returns:

the crn

setCrn

public void setCrn(String crn)

Sets the crn.

Parameters:

crn - the new crn

listZones

public com.ibm.cloud.sdk.core.http.ServiceCall<ListZonesResp> listZones(ListZonesOptions listZonesOptions)

List all zones. List all zones for a service instance.

Parameters:

listZonesOptions - the ListZonesOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListZonesResp

listZones

public com.ibm.cloud.sdk.core.http.ServiceCall<ListZonesResp> listZones()

List all zones. List all zones for a service instance.

Returns:

a ServiceCall with a result of type ListZonesResp

createZone

public com.ibm.cloud.sdk.core.http.ServiceCall<ZoneResp> createZone(CreateZoneOptions createZoneOptions)

Create zone. Add a new zone for a given service instance.

Parameters:

createZoneOptions - the CreateZoneOptions containing the options for the call

Returns:

a ServiceCall with a result of type ZoneResp

createZone

public com.ibm.cloud.sdk.core.http.ServiceCall<ZoneResp> createZone()

Create zone. Add a new zone for a given service instance.

Returns:

a ServiceCall with a result of type ZoneResp

deleteZone

public com.ibm.cloud.sdk.core.http.ServiceCall<DeleteZoneResp> deleteZone(DeleteZoneOptions deleteZoneOptions)

Delete zone. Delete a zone given its id.

Parameters:

deleteZoneOptions - the DeleteZoneOptions containing the options for the call

Returns:

a ServiceCall with a result of type DeleteZoneResp

getZone

public com.ibm.cloud.sdk.core.http.ServiceCall<ZoneResp> getZone(GetZoneOptions getZoneOptions)

Get zone. Get the details of a zone for a given service instance and given zone id.

Parameters:

getZoneOptions - the GetZoneOptions containing the options for the call

Returns:

a ServiceCall with a result of type ZoneResp

updateZone

public com.ibm.cloud.sdk.core.http.ServiceCall<ZoneResp> updateZone(UpdateZoneOptions updateZoneOptions)

Update zone. Update the paused field of the zone.

Parameters:

updateZoneOptions - the UpdateZoneOptions containing the options for the call

Returns:

a ServiceCall with a result of type ZoneResp

zoneActivationCheck

public com.ibm.cloud.sdk.core.http.ServiceCall<ZoneActivationcheckResp> zoneActivationCheck(ZoneActivationCheckOptions zoneActivationCheckOptions)

Check zone. Perform activation check on zone for status.

Parameters:

zoneActivationCheckOptions - the ZoneActivationCheckOptions containing the options for the call

Returns:

a ServiceCall with a result of type ZoneActivationcheckResp