Package com.ibm.cloud.networking.security_events_api.v1

Class SecurityEventsApi

java.lang.Object

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

com.ibm.cloud.networking.security_events_api.v1.SecurityEventsApi

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

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

Method Summary

Modifier and Type	Method	Description
String	getCrn()	Gets the crn.
String	getZoneId()	Gets the zoneId.
static SecurityEventsApi	newInstance(String crn, String zoneId)	Class method which constructs an instance of the `SecurityEventsApi` client.
static SecurityEventsApi	newInstance(String crn, String zoneId, String serviceName)	Class method which constructs an instance of the `SecurityEventsApi` client.
com.ibm.cloud.sdk.core.http.ServiceCall<SecurityEvents>	securityEvents()	Logs of the mitigations performed by Firewall features.
com.ibm.cloud.sdk.core.http.ServiceCall<SecurityEvents>	securityEvents(SecurityEventsOptions securityEventsOptions)	Logs of the mitigations performed by Firewall features.
void	setCrn(String crn)	Sets the crn.
void	setZoneId(String zoneId)	Sets the zoneId.

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

SecurityEventsApi

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

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

Parameters:

crn - Full url-encoded cloud resource name (CRN) of resource instance.

zoneId - zone identifier.

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

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

Parameters:

crn - Full url-encoded cloud resource name (CRN) of resource instance.

zoneId - zone identifier.

Returns:

an instance of the `SecurityEventsApi` client using external configuration

newInstance

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

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

Parameters:

crn - Full url-encoded cloud resource name (CRN) of resource instance.

zoneId - zone identifier.

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

Returns:

an instance of the `SecurityEventsApi` client using external configuration

getCrn

public String getCrn()

Gets the crn. Full url-encoded cloud resource name (CRN) of resource instance.

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 identifier.

Returns:

the zoneId

setZoneId

public void setZoneId(String zoneId)

Sets the zoneId.

Parameters:

zoneId - the new zoneId

securityEvents

public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityEvents> securityEvents(SecurityEventsOptions securityEventsOptions)

Logs of the mitigations performed by Firewall features. Provides a full log of the mitigations performed by the CIS Firewall features including; Firewall Rules, Rate Limiting, Security Level, Access Rules (IP, IP Range, ASN, and Country), WAF (Web Application Firewall), User Agent Blocking, Zone Lockdown, and Advanced DDoS Protection.

Parameters:

securityEventsOptions - the SecurityEventsOptions containing the options for the call

Returns:

a ServiceCall with a result of type SecurityEvents

securityEvents

public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityEvents> securityEvents()

Logs of the mitigations performed by Firewall features. Provides a full log of the mitigations performed by the CIS Firewall features including; Firewall Rules, Rate Limiting, Security Level, Access Rules (IP, IP Range, ASN, and Country), WAF (Web Application Firewall), User Agent Blocking, Zone Lockdown, and Advanced DDoS Protection.

Returns:

a ServiceCall with a result of type SecurityEvents