Package com.ibm.cloud.networking.webhooks.v1

Class Webhooks

java.lang.Object

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

com.ibm.cloud.networking.webhooks.v1.Webhooks

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

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

Method Summary

Modifier and Type	Method	Description
com.ibm.cloud.sdk.core.http.ServiceCall<WebhookSuccessResp>	createAlertWebhook()	Create an alert webhook.
com.ibm.cloud.sdk.core.http.ServiceCall<WebhookSuccessResp>	createAlertWebhook(CreateAlertWebhookOptions createAlertWebhookOptions)	Create an alert webhook.
com.ibm.cloud.sdk.core.http.ServiceCall<WebhookSuccessResp>	deleteWebhook(DeleteWebhookOptions deleteWebhookOptions)	Delete an alert webhook.
String	getCrn()	Gets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<GetAlertWebhookResp>	getWebhook(GetWebhookOptions getWebhookOptions)	Get an alert webhook.
com.ibm.cloud.sdk.core.http.ServiceCall<ListAlertWebhooksResp>	listWebhooks()	List alert webhooks.
com.ibm.cloud.sdk.core.http.ServiceCall<ListAlertWebhooksResp>	listWebhooks(ListWebhooksOptions listWebhooksOptions)	List alert webhooks.
static Webhooks	newInstance(String crn)	Class method which constructs an instance of the `Webhooks` client.
static Webhooks	newInstance(String crn, String serviceName)	Class method which constructs an instance of the `Webhooks` client.
void	setCrn(String crn)	Sets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<WebhookSuccessResp>	updateAlertWebhook(UpdateAlertWebhookOptions updateAlertWebhookOptions)	Update an alert webhook.

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

Webhooks

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

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

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

newInstance

public static Webhooks newInstance(String crn,
                                   String serviceName)

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

listWebhooks

public com.ibm.cloud.sdk.core.http.ServiceCall<ListAlertWebhooksResp> listWebhooks(ListWebhooksOptions listWebhooksOptions)

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

Parameters:

listWebhooksOptions - the ListWebhooksOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListAlertWebhooksResp

listWebhooks

public com.ibm.cloud.sdk.core.http.ServiceCall<ListAlertWebhooksResp> listWebhooks()

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

Returns:

a ServiceCall with a result of type ListAlertWebhooksResp

createAlertWebhook

public com.ibm.cloud.sdk.core.http.ServiceCall<WebhookSuccessResp> createAlertWebhook(CreateAlertWebhookOptions createAlertWebhookOptions)

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

Parameters:

createAlertWebhookOptions - the CreateAlertWebhookOptions containing the options for the call

Returns:

a ServiceCall with a result of type WebhookSuccessResp

createAlertWebhook

public com.ibm.cloud.sdk.core.http.ServiceCall<WebhookSuccessResp> createAlertWebhook()

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

Returns:

a ServiceCall with a result of type WebhookSuccessResp

getWebhook

public com.ibm.cloud.sdk.core.http.ServiceCall<GetAlertWebhookResp> getWebhook(GetWebhookOptions getWebhookOptions)

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

Parameters:

getWebhookOptions - the GetWebhookOptions containing the options for the call

Returns:

a ServiceCall with a result of type GetAlertWebhookResp

updateAlertWebhook

public com.ibm.cloud.sdk.core.http.ServiceCall<WebhookSuccessResp> updateAlertWebhook(UpdateAlertWebhookOptions updateAlertWebhookOptions)

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

Parameters:

updateAlertWebhookOptions - the UpdateAlertWebhookOptions containing the options for the call

Returns:

a ServiceCall with a result of type WebhookSuccessResp

deleteWebhook

public com.ibm.cloud.sdk.core.http.ServiceCall<WebhookSuccessResp> deleteWebhook(DeleteWebhookOptions deleteWebhookOptions)

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

Parameters:

deleteWebhookOptions - the DeleteWebhookOptions containing the options for the call

Returns:

a ServiceCall with a result of type WebhookSuccessResp