Package com.ibm.cloud.networking.waf_rules_api.v1

Class WafRulesApi

java.lang.Object

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

com.ibm.cloud.networking.waf_rules_api.v1.WafRulesApi

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

This document describes CIS WAF Rules 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
WafRulesApi(String crn, String zoneId, String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)	Constructs an instance of the `WafRulesApi` client.

Method Summary

Modifier and Type	Method	Description
String	getCrn()	Gets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<WafRuleResponse>	getWafRule(GetWafRuleOptions getWafRuleOptions)	Get WAF rule.
String	getZoneId()	Gets the zoneId.
com.ibm.cloud.sdk.core.http.ServiceCall<WafRulesResponse>	listWafRules(ListWafRulesOptions listWafRulesOptions)	List all WAF rules.
static WafRulesApi	newInstance(String crn, String zoneId)	Class method which constructs an instance of the `WafRulesApi` client.
static WafRulesApi	newInstance(String crn, String zoneId, String serviceName)	Class method which constructs an instance of the `WafRulesApi` client.
void	setCrn(String crn)	Sets the crn.
void	setZoneId(String zoneId)	Sets the zoneId.
com.ibm.cloud.sdk.core.http.ServiceCall<WafRuleResponse>	updateWafRule(UpdateWafRuleOptions updateWafRuleOptions)	Update WAF 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

WafRulesApi

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

Constructs an instance of the `WafRulesApi` 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 WafRulesApi newInstance(String crn,
                                      String zoneId)

Class method which constructs an instance of the `WafRulesApi` 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 `WafRulesApi` client using external configuration

newInstance

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

Class method which constructs an instance of the `WafRulesApi` 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 `WafRulesApi` 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

listWafRules

public com.ibm.cloud.sdk.core.http.ServiceCall<WafRulesResponse> listWafRules(ListWafRulesOptions listWafRulesOptions)

List all WAF rules. List all Web Application Firewall (WAF) rules.

Parameters:

listWafRulesOptions - the ListWafRulesOptions containing the options for the call

Returns:

a ServiceCall with a result of type WafRulesResponse

getWafRule

public com.ibm.cloud.sdk.core.http.ServiceCall<WafRuleResponse> getWafRule(GetWafRuleOptions getWafRuleOptions)

Get WAF rule. Get individual information about a rule.

Parameters:

getWafRuleOptions - the GetWafRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type WafRuleResponse

updateWafRule

public com.ibm.cloud.sdk.core.http.ServiceCall<WafRuleResponse> updateWafRule(UpdateWafRuleOptions updateWafRuleOptions)

Update WAF rule. Update the action the rule will perform if triggered on the zone.

Parameters:

updateWafRuleOptions - the UpdateWafRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type WafRuleResponse