Package com.ibm.cloud.networking.alerts.v1

Class Alerts

java.lang.Object

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

com.ibm.cloud.networking.alerts.v1.Alerts

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

CIS Alert Policies. API Version: 1.0.0

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

Method Summary

Modifier and Type	Method	Description
com.ibm.cloud.sdk.core.http.ServiceCall<AlertSuccessResp>	createAlertPolicy()	Create an alert policy.
com.ibm.cloud.sdk.core.http.ServiceCall<AlertSuccessResp>	createAlertPolicy(CreateAlertPolicyOptions createAlertPolicyOptions)	Create an alert policy.
com.ibm.cloud.sdk.core.http.ServiceCall<AlertSuccessResp>	deleteAlertPolicy(DeleteAlertPolicyOptions deleteAlertPolicyOptions)	Delete an alert policy.
com.ibm.cloud.sdk.core.http.ServiceCall<ListAlertPoliciesResp>	getAlertPolicies()	List alert policies.
com.ibm.cloud.sdk.core.http.ServiceCall<ListAlertPoliciesResp>	getAlertPolicies(GetAlertPoliciesOptions getAlertPoliciesOptions)	List alert policies.
com.ibm.cloud.sdk.core.http.ServiceCall<GetAlertPolicyResp>	getAlertPolicy(GetAlertPolicyOptions getAlertPolicyOptions)	Get an alert policy.
String	getCrn()	Gets the crn.
static Alerts	newInstance(String crn)	Class method which constructs an instance of the `Alerts` client.
static Alerts	newInstance(String crn, String serviceName)	Class method which constructs an instance of the `Alerts` client.
void	setCrn(String crn)	Sets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<AlertSuccessResp>	updateAlertPolicy(UpdateAlertPolicyOptions updateAlertPolicyOptions)	Update an alert policy.

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

Alerts

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

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

Parameters:

crn - Full url-encoded CRN of the service instance.

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 Alerts newInstance(String crn)

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

Parameters:

crn - Full url-encoded CRN of the service instance.

Returns:

an instance of the `Alerts` client using external configuration

newInstance

public static Alerts newInstance(String crn,
                                 String serviceName)

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

Parameters:

crn - Full url-encoded CRN of the service instance.

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

Returns:

an instance of the `Alerts` client using external configuration

getCrn

public String getCrn()

Gets the crn. Full url-encoded CRN of the service instance.

Returns:

the crn

setCrn

public void setCrn(String crn)

Sets the crn.

Parameters:

crn - the new crn

getAlertPolicies

public com.ibm.cloud.sdk.core.http.ServiceCall<ListAlertPoliciesResp> getAlertPolicies(GetAlertPoliciesOptions getAlertPoliciesOptions)

List alert policies. List configured alert policies for the CIS instance.

Parameters:

getAlertPoliciesOptions - the GetAlertPoliciesOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListAlertPoliciesResp

getAlertPolicies

public com.ibm.cloud.sdk.core.http.ServiceCall<ListAlertPoliciesResp> getAlertPolicies()

List alert policies. List configured alert policies for the CIS instance.

Returns:

a ServiceCall with a result of type ListAlertPoliciesResp

createAlertPolicy

public com.ibm.cloud.sdk.core.http.ServiceCall<AlertSuccessResp> createAlertPolicy(CreateAlertPolicyOptions createAlertPolicyOptions)

Create an alert policy. Create a new alert policy for the CIS instance.

Parameters:

createAlertPolicyOptions - the CreateAlertPolicyOptions containing the options for the call

Returns:

a ServiceCall with a result of type AlertSuccessResp

createAlertPolicy

public com.ibm.cloud.sdk.core.http.ServiceCall<AlertSuccessResp> createAlertPolicy()

Create an alert policy. Create a new alert policy for the CIS instance.

Returns:

a ServiceCall with a result of type AlertSuccessResp

getAlertPolicy

public com.ibm.cloud.sdk.core.http.ServiceCall<GetAlertPolicyResp> getAlertPolicy(GetAlertPolicyOptions getAlertPolicyOptions)

Get an alert policy. Get an alert policy for the CIS instance.

Parameters:

getAlertPolicyOptions - the GetAlertPolicyOptions containing the options for the call

Returns:

a ServiceCall with a result of type GetAlertPolicyResp

updateAlertPolicy

public com.ibm.cloud.sdk.core.http.ServiceCall<AlertSuccessResp> updateAlertPolicy(UpdateAlertPolicyOptions updateAlertPolicyOptions)

Update an alert policy. Update an existing alert policy for the CIS instance.

Parameters:

updateAlertPolicyOptions - the UpdateAlertPolicyOptions containing the options for the call

Returns:

a ServiceCall with a result of type AlertSuccessResp

deleteAlertPolicy

public com.ibm.cloud.sdk.core.http.ServiceCall<AlertSuccessResp> deleteAlertPolicy(DeleteAlertPolicyOptions deleteAlertPolicyOptions)

Delete an alert policy. Delete an alert policy for the CIS instance.

Parameters:

deleteAlertPolicyOptions - the DeleteAlertPolicyOptions containing the options for the call

Returns:

a ServiceCall with a result of type AlertSuccessResp