com.ibm.cloud.networking.user_agent_blocking_rules.v1

Class UserAgentBlockingRules

java.lang.Object

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

com.ibm.cloud.networking.user_agent_blocking_rules.v1.UserAgentBlockingRules

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

User-Agent Blocking Rules.

Version:

v1

Field Summary

Fields

Modifier and Type	Field and 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 and Description
UserAgentBlockingRules(String crn, String zoneIdentifier, String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `UserAgentBlockingRules` client.

Method Summary

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<UseragentRuleResp>	createZoneUserAgentRule() Create user-agent blocking rule.
com.ibm.cloud.sdk.core.http.ServiceCall<UseragentRuleResp>	createZoneUserAgentRule(CreateZoneUserAgentRuleOptions createZoneUserAgentRuleOptions) Create user-agent blocking rule.
com.ibm.cloud.sdk.core.http.ServiceCall<DeleteUseragentRuleResp>	deleteZoneUserAgentRule(DeleteZoneUserAgentRuleOptions deleteZoneUserAgentRuleOptions) Delete user-agent blocking rule.
String	getCrn() Gets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<UseragentRuleResp>	getUserAgentRule(GetUserAgentRuleOptions getUserAgentRuleOptions) Get user-agent blocking rule.
String	getZoneIdentifier() Gets the zoneIdentifier.
com.ibm.cloud.sdk.core.http.ServiceCall<ListUseragentRulesResp>	listAllZoneUserAgentRules() List all user-agent blocking rules.
com.ibm.cloud.sdk.core.http.ServiceCall<ListUseragentRulesResp>	listAllZoneUserAgentRules(ListAllZoneUserAgentRulesOptions listAllZoneUserAgentRulesOptions) List all user-agent blocking rules.
static UserAgentBlockingRules	newInstance(String crn, String zoneIdentifier) Class method which constructs an instance of the `UserAgentBlockingRules` client.
static UserAgentBlockingRules	newInstance(String crn, String zoneIdentifier, String serviceName) Class method which constructs an instance of the `UserAgentBlockingRules` client.
void	setCrn(String crn) Sets the crn.
void	setZoneIdentifier(String zoneIdentifier) Sets the zoneIdentifier.
com.ibm.cloud.sdk.core.http.ServiceCall<UseragentRuleResp>	updateUserAgentRule(UpdateUserAgentRuleOptions updateUserAgentRuleOptions) Update user-agent blocking rule.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureService, constructServiceUrl, constructServiceURL, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, 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

UserAgentBlockingRules

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

Constructs an instance of the `UserAgentBlockingRules` 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.

zoneIdentifier - Zone identifier of the zone for which user-agent rule is created.

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 UserAgentBlockingRules newInstance(String crn,
                                                 String zoneIdentifier)

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

Parameters:

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

zoneIdentifier - Zone identifier of the zone for which user-agent rule is created.

Returns:

an instance of the `UserAgentBlockingRules` client using external configuration

newInstance

public static UserAgentBlockingRules newInstance(String crn,
                                                 String zoneIdentifier,
                                                 String serviceName)

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

Parameters:

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

zoneIdentifier - Zone identifier of the zone for which user-agent rule is created.

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

Returns:

an instance of the `UserAgentBlockingRules` 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

getZoneIdentifier

public String getZoneIdentifier()

Gets the zoneIdentifier. Zone identifier of the zone for which user-agent rule is created.

Returns:

the zoneIdentifier

setZoneIdentifier

public void setZoneIdentifier(String zoneIdentifier)

Sets the zoneIdentifier.

Parameters:

zoneIdentifier - the new zoneIdentifier

listAllZoneUserAgentRules

public com.ibm.cloud.sdk.core.http.ServiceCall<ListUseragentRulesResp> listAllZoneUserAgentRules(ListAllZoneUserAgentRulesOptions listAllZoneUserAgentRulesOptions)

List all user-agent blocking rules. List all user agent blocking rules.

Parameters:

listAllZoneUserAgentRulesOptions - the ListAllZoneUserAgentRulesOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListUseragentRulesResp

listAllZoneUserAgentRules

public com.ibm.cloud.sdk.core.http.ServiceCall<ListUseragentRulesResp> listAllZoneUserAgentRules()

List all user-agent blocking rules. List all user agent blocking rules.

Returns:

a ServiceCall with a result of type ListUseragentRulesResp

createZoneUserAgentRule

public com.ibm.cloud.sdk.core.http.ServiceCall<UseragentRuleResp> createZoneUserAgentRule(CreateZoneUserAgentRuleOptions createZoneUserAgentRuleOptions)

Create user-agent blocking rule. Create a new user-agent blocking rule for a given zone under a service instance.

Parameters:

createZoneUserAgentRuleOptions - the CreateZoneUserAgentRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type UseragentRuleResp

createZoneUserAgentRule

public com.ibm.cloud.sdk.core.http.ServiceCall<UseragentRuleResp> createZoneUserAgentRule()

Create user-agent blocking rule. Create a new user-agent blocking rule for a given zone under a service instance.

Returns:

a ServiceCall with a result of type UseragentRuleResp

deleteZoneUserAgentRule

public com.ibm.cloud.sdk.core.http.ServiceCall<DeleteUseragentRuleResp> deleteZoneUserAgentRule(DeleteZoneUserAgentRuleOptions deleteZoneUserAgentRuleOptions)

Delete user-agent blocking rule. Delete a user-agent blocking rule for a particular zone, given its id.

Parameters:

deleteZoneUserAgentRuleOptions - the DeleteZoneUserAgentRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type DeleteUseragentRuleResp

getUserAgentRule

public com.ibm.cloud.sdk.core.http.ServiceCall<UseragentRuleResp> getUserAgentRule(GetUserAgentRuleOptions getUserAgentRuleOptions)

Get user-agent blocking rule. For a given service instance, zone id and user-agent rule id, get the user-agent blocking rule details.

Parameters:

getUserAgentRuleOptions - the GetUserAgentRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type UseragentRuleResp

updateUserAgentRule

public com.ibm.cloud.sdk.core.http.ServiceCall<UseragentRuleResp> updateUserAgentRule(UpdateUserAgentRuleOptions updateUserAgentRuleOptions)

Update user-agent blocking rule. Update an existing user-agent blocking rule for a given zone under a given service instance.

Parameters:

updateUserAgentRuleOptions - the UpdateUserAgentRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type UseragentRuleResp