Package com.ibm.cloud.networking.zone_lockdown.v1

Class ZoneLockdown

java.lang.Object

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

com.ibm.cloud.networking.zone_lockdown.v1.ZoneLockdown

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

Zone Lockdown.

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
ZoneLockdown(String crn, String zoneIdentifier, String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)	Constructs an instance of the `ZoneLockdown` client.

Method Summary

Modifier and Type	Method	Description
com.ibm.cloud.sdk.core.http.ServiceCall<LockdownResp>	createZoneLockdownRule()	Create lockdown rule.
com.ibm.cloud.sdk.core.http.ServiceCall<LockdownResp>	createZoneLockdownRule(CreateZoneLockdownRuleOptions createZoneLockdownRuleOptions)	Create lockdown rule.
com.ibm.cloud.sdk.core.http.ServiceCall<DeleteLockdownResp>	deleteZoneLockdownRule(DeleteZoneLockdownRuleOptions deleteZoneLockdownRuleOptions)	Delete lockdown rule.
String	getCrn()	Gets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<LockdownResp>	getLockdown(GetLockdownOptions getLockdownOptions)	Get lockdown rule.
String	getZoneIdentifier()	Gets the zoneIdentifier.
com.ibm.cloud.sdk.core.http.ServiceCall<ListLockdownResp>	listAllZoneLockownRules()	List all lockdown rules.
com.ibm.cloud.sdk.core.http.ServiceCall<ListLockdownResp>	listAllZoneLockownRules(ListAllZoneLockownRulesOptions listAllZoneLockownRulesOptions)	List all lockdown rules.
static ZoneLockdown	newInstance(String crn, String zoneIdentifier)	Class method which constructs an instance of the `ZoneLockdown` client.
static ZoneLockdown	newInstance(String crn, String zoneIdentifier, String serviceName)	Class method which constructs an instance of the `ZoneLockdown` client.
void	setCrn(String crn)	Sets the crn.
void	setZoneIdentifier(String zoneIdentifier)	Sets the zoneIdentifier.
com.ibm.cloud.sdk.core.http.ServiceCall<LockdownResp>	updateLockdownRule(UpdateLockdownRuleOptions updateLockdownRuleOptions)	Update lockdown rule.

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

ZoneLockdown

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

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

Parameters:

crn - Full crn of the service instance.

zoneIdentifier - Zone identifier (zone id).

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 ZoneLockdown newInstance(String crn,
                                       String zoneIdentifier)

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

Parameters:

crn - Full crn of the service instance.

zoneIdentifier - Zone identifier (zone id).

Returns:

an instance of the `ZoneLockdown` client using external configuration

newInstance

public static ZoneLockdown newInstance(String crn,
                                       String zoneIdentifier,
                                       String serviceName)

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

Parameters:

crn - Full crn of the service instance.

zoneIdentifier - Zone identifier (zone id).

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

Returns:

an instance of the `ZoneLockdown` client using external configuration

getCrn

public String getCrn()

Gets the crn. Full crn of the service instance.

Returns:

the crn

setCrn

public void setCrn(String crn)

Sets the crn.

Parameters:

crn - the new crn

getZoneIdentifier

public String getZoneIdentifier()

Gets the zoneIdentifier. Zone identifier (zone id).

Returns:

the zoneIdentifier

setZoneIdentifier

public void setZoneIdentifier(String zoneIdentifier)

Sets the zoneIdentifier.

Parameters:

zoneIdentifier - the new zoneIdentifier

listAllZoneLockownRules

public com.ibm.cloud.sdk.core.http.ServiceCall<ListLockdownResp> listAllZoneLockownRules(ListAllZoneLockownRulesOptions listAllZoneLockownRulesOptions)

List all lockdown rules. List all lockdown rules for a zone.

Parameters:

listAllZoneLockownRulesOptions - the ListAllZoneLockownRulesOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListLockdownResp

listAllZoneLockownRules

public com.ibm.cloud.sdk.core.http.ServiceCall<ListLockdownResp> listAllZoneLockownRules()

List all lockdown rules. List all lockdown rules for a zone.

Returns:

a ServiceCall with a result of type ListLockdownResp

createZoneLockdownRule

public com.ibm.cloud.sdk.core.http.ServiceCall<LockdownResp> createZoneLockdownRule(CreateZoneLockdownRuleOptions createZoneLockdownRuleOptions)

Create lockdown rule. Create a new lockdown rule for a given zone under a service instance.

Parameters:

createZoneLockdownRuleOptions - the CreateZoneLockdownRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type LockdownResp

createZoneLockdownRule

public com.ibm.cloud.sdk.core.http.ServiceCall<LockdownResp> createZoneLockdownRule()

Create lockdown rule. Create a new lockdown rule for a given zone under a service instance.

Returns:

a ServiceCall with a result of type LockdownResp

deleteZoneLockdownRule

public com.ibm.cloud.sdk.core.http.ServiceCall<DeleteLockdownResp> deleteZoneLockdownRule(DeleteZoneLockdownRuleOptions deleteZoneLockdownRuleOptions)

Delete lockdown rule. Delete a lockdown rule for a particular zone, given its id.

Parameters:

deleteZoneLockdownRuleOptions - the DeleteZoneLockdownRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type DeleteLockdownResp

getLockdown

public com.ibm.cloud.sdk.core.http.ServiceCall<LockdownResp> getLockdown(GetLockdownOptions getLockdownOptions)

Get lockdown rule. For a given service instance, zone id and lockdown rule id, get the lockdown rule details.

Parameters:

getLockdownOptions - the GetLockdownOptions containing the options for the call

Returns:

a ServiceCall with a result of type LockdownResp

updateLockdownRule

public com.ibm.cloud.sdk.core.http.ServiceCall<LockdownResp> updateLockdownRule(UpdateLockdownRuleOptions updateLockdownRuleOptions)

Update lockdown rule. Update an existing lockdown rule for a given zone under a given service instance.

Parameters:

updateLockdownRuleOptions - the UpdateLockdownRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type LockdownResp