com.ibm.cloud.platform_services.context_based_restrictions.v1

Class ContextBasedRestrictions

java.lang.Object

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

com.ibm.cloud.platform_services.context_based_restrictions.v1.ContextBasedRestrictions

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

With the Context Based Restrictions API, you can: * Create, list, get, replace, and delete network zones * Create, list, get, replace, and delete context-based restriction rules * Get account settings .

Version:

v1

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SERVICE_NAME
static java.lang.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 and Description
ContextBasedRestrictions(java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `ContextBasedRestrictions` client.

Method Summary

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<Rule>	createRule() Create a rule.
com.ibm.cloud.sdk.core.http.ServiceCall<Rule>	createRule(CreateRuleOptions createRuleOptions) Create a rule.
com.ibm.cloud.sdk.core.http.ServiceCall<Zone>	createZone() Create a network zone.
com.ibm.cloud.sdk.core.http.ServiceCall<Zone>	createZone(CreateZoneOptions createZoneOptions) Create a network zone.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	deleteRule(DeleteRuleOptions deleteRuleOptions) Delete a rule.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	deleteZone(DeleteZoneOptions deleteZoneOptions) Delete a network zone.
com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettings>	getAccountSettings(GetAccountSettingsOptions getAccountSettingsOptions) Get account settings.
com.ibm.cloud.sdk.core.http.ServiceCall<Rule>	getRule(GetRuleOptions getRuleOptions) Get a rule.
com.ibm.cloud.sdk.core.http.ServiceCall<Zone>	getZone(GetZoneOptions getZoneOptions) Get a network zone.
com.ibm.cloud.sdk.core.http.ServiceCall<ServiceRefTargetList>	listAvailableServicerefTargets() List available service reference targets.
com.ibm.cloud.sdk.core.http.ServiceCall<ServiceRefTargetList>	listAvailableServicerefTargets(ListAvailableServicerefTargetsOptions listAvailableServicerefTargetsOptions) List available service reference targets.
com.ibm.cloud.sdk.core.http.ServiceCall<RuleList>	listRules(ListRulesOptions listRulesOptions) List rules.
com.ibm.cloud.sdk.core.http.ServiceCall<ZoneList>	listZones(ListZonesOptions listZonesOptions) List network zones.
static ContextBasedRestrictions	newInstance() Class method which constructs an instance of the `ContextBasedRestrictions` client.
static ContextBasedRestrictions	newInstance(java.lang.String serviceName) Class method which constructs an instance of the `ContextBasedRestrictions` client.
com.ibm.cloud.sdk.core.http.ServiceCall<Rule>	replaceRule(ReplaceRuleOptions replaceRuleOptions) Replace a rule.
com.ibm.cloud.sdk.core.http.ServiceCall<Zone>	replaceZone(ReplaceZoneOptions replaceZoneOptions) Replace a network 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 java.lang.String DEFAULT_SERVICE_NAME

See Also:

Constant Field Values

DEFAULT_SERVICE_URL

public static final java.lang.String DEFAULT_SERVICE_URL

See Also:

Constant Field Values

Constructor Detail

ContextBasedRestrictions

public ContextBasedRestrictions(java.lang.String serviceName,
                                com.ibm.cloud.sdk.core.security.Authenticator authenticator)

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

Parameters:

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 ContextBasedRestrictions newInstance()

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

Returns:

an instance of the `ContextBasedRestrictions` client using external configuration

newInstance

public static ContextBasedRestrictions newInstance(java.lang.String serviceName)

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

Parameters:

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

Returns:

an instance of the `ContextBasedRestrictions` client using external configuration

createZone

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

Create a network zone. This operation creates a network zone for the specified account.

Parameters:

createZoneOptions - the CreateZoneOptions containing the options for the call

Returns:

a ServiceCall with a result of type Zone

createZone

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

Create a network zone. This operation creates a network zone for the specified account.

Returns:

a ServiceCall with a result of type Zone

listZones

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

List network zones. This operation lists network zones in the specified account.

Parameters:

listZonesOptions - the ListZonesOptions containing the options for the call

Returns:

a ServiceCall with a result of type ZoneList

getZone

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

Get a network zone. This operation retrieves the network zone identified by the specified zone ID.

Parameters:

getZoneOptions - the GetZoneOptions containing the options for the call

Returns:

a ServiceCall with a result of type Zone

replaceZone

public com.ibm.cloud.sdk.core.http.ServiceCall<Zone> replaceZone(ReplaceZoneOptions replaceZoneOptions)

Replace a network zone. This operation replaces the network zone identified by the specified zone ID. Partial updates are not supported. The entire network zone object must be replaced.

Parameters:

replaceZoneOptions - the ReplaceZoneOptions containing the options for the call

Returns:

a ServiceCall with a result of type Zone

deleteZone

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

Delete a network zone. This operation deletes the network zone identified by the specified zone ID.

Parameters:

deleteZoneOptions - the DeleteZoneOptions containing the options for the call

Returns:

a ServiceCall with a void result

listAvailableServicerefTargets

public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceRefTargetList> listAvailableServicerefTargets(ListAvailableServicerefTargetsOptions listAvailableServicerefTargetsOptions)

List available service reference targets. This operation lists all available service reference targets.

Parameters:

listAvailableServicerefTargetsOptions - the ListAvailableServicerefTargetsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ServiceRefTargetList

listAvailableServicerefTargets

public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceRefTargetList> listAvailableServicerefTargets()

List available service reference targets. This operation lists all available service reference targets.

Returns:

a ServiceCall with a result of type ServiceRefTargetList

createRule

public com.ibm.cloud.sdk.core.http.ServiceCall<Rule> createRule(CreateRuleOptions createRuleOptions)

Create a rule. This operation creates a rule for the specified account.

Parameters:

createRuleOptions - the CreateRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type Rule

createRule

public com.ibm.cloud.sdk.core.http.ServiceCall<Rule> createRule()

Create a rule. This operation creates a rule for the specified account.

Returns:

a ServiceCall with a result of type Rule

listRules

public com.ibm.cloud.sdk.core.http.ServiceCall<RuleList> listRules(ListRulesOptions listRulesOptions)

List rules. This operation lists rules in the specified account.

Parameters:

listRulesOptions - the ListRulesOptions containing the options for the call

Returns:

a ServiceCall with a result of type RuleList

getRule

public com.ibm.cloud.sdk.core.http.ServiceCall<Rule> getRule(GetRuleOptions getRuleOptions)

Get a rule. This operation retrieves the rule identified by the specified rule ID.

Parameters:

getRuleOptions - the GetRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type Rule

replaceRule

public com.ibm.cloud.sdk.core.http.ServiceCall<Rule> replaceRule(ReplaceRuleOptions replaceRuleOptions)

Replace a rule. This operation replaces the rule identified by the specified rule ID. Partial updates are not supported. The entire rule object must be replaced.

Parameters:

replaceRuleOptions - the ReplaceRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type Rule

deleteRule

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteRule(DeleteRuleOptions deleteRuleOptions)

Delete a rule. This operation deletes the rule identified by the specified rule ID.

Parameters:

deleteRuleOptions - the DeleteRuleOptions containing the options for the call

Returns:

a ServiceCall with a void result

getAccountSettings

public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettings> getAccountSettings(GetAccountSettingsOptions getAccountSettingsOptions)

Get account settings. This operation retrieves the settings for the specified account ID.

Parameters:

getAccountSettingsOptions - the GetAccountSettingsOptions containing the options for the call

Returns:

a ServiceCall with a result of type AccountSettings