Package com.ibm.cloud.networking.waf_api.v1

Class WafApi

java.lang.Object

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

com.ibm.cloud.networking.waf_api.v1.WafApi

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

This document describes CIS WAF API.

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

Method Summary

Modifier and Type	Method	Description
String	getCrn()	Gets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<WafResponse>	getWafSettings()	Get WAF setting.
com.ibm.cloud.sdk.core.http.ServiceCall<WafResponse>	getWafSettings(GetWafSettingsOptions getWafSettingsOptions)	Get WAF setting.
String	getZoneId()	Gets the zoneId.
static WafApi	newInstance(String crn, String zoneId)	Class method which constructs an instance of the `WafApi` client.
static WafApi	newInstance(String crn, String zoneId, String serviceName)	Class method which constructs an instance of the `WafApi` client.
void	setCrn(String crn)	Sets the crn.
void	setZoneId(String zoneId)	Sets the zoneId.
com.ibm.cloud.sdk.core.http.ServiceCall<WafResponse>	updateWafSettings()	Set WAF setting.
com.ibm.cloud.sdk.core.http.ServiceCall<WafResponse>	updateWafSettings(UpdateWafSettingsOptions updateWafSettingsOptions)	Set WAF setting.

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

WafApi

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

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

Parameters:

crn - cloud resource name.

zoneId - 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 WafApi newInstance(String crn,
                                 String zoneId)

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

Parameters:

crn - cloud resource name.

zoneId - zone id.

Returns:

an instance of the `WafApi` client using external configuration

newInstance

public static WafApi newInstance(String crn,
                                 String zoneId,
                                 String serviceName)

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

Parameters:

crn - cloud resource name.

zoneId - zone id.

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

Returns:

an instance of the `WafApi` client using external configuration

getCrn

public String getCrn()

Gets the crn. cloud resource name.

Returns:

the crn

setCrn

public void setCrn(String crn)

Sets the crn.

Parameters:

crn - the new crn

getZoneId

public String getZoneId()

Gets the zoneId. zone id.

Returns:

the zoneId

setZoneId

public void setZoneId(String zoneId)

Sets the zoneId.

Parameters:

zoneId - the new zoneId

getWafSettings

public com.ibm.cloud.sdk.core.http.ServiceCall<WafResponse> getWafSettings(GetWafSettingsOptions getWafSettingsOptions)

Get WAF setting. Get WAF of a specific zone.

Parameters:

getWafSettingsOptions - the GetWafSettingsOptions containing the options for the call

Returns:

a ServiceCall with a result of type WafResponse

getWafSettings

public com.ibm.cloud.sdk.core.http.ServiceCall<WafResponse> getWafSettings()

Get WAF setting. Get WAF of a specific zone.

Returns:

a ServiceCall with a result of type WafResponse

updateWafSettings

public com.ibm.cloud.sdk.core.http.ServiceCall<WafResponse> updateWafSettings(UpdateWafSettingsOptions updateWafSettingsOptions)

Set WAF setting. Set WAF (on | off) for a specific zone.

Parameters:

updateWafSettingsOptions - the UpdateWafSettingsOptions containing the options for the call

Returns:

a ServiceCall with a result of type WafResponse

updateWafSettings

public com.ibm.cloud.sdk.core.http.ServiceCall<WafResponse> updateWafSettings()

Set WAF setting. Set WAF (on | off) for a specific zone.

Returns:

a ServiceCall with a result of type WafResponse