Package com.ibm.cloud.networking.zone_rate_limits.v1

Class ZoneRateLimits

java.lang.Object

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

com.ibm.cloud.networking.zone_rate_limits.v1.ZoneRateLimits

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

Zone Rate Limits.

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

Method Summary

Modifier and Type	Method	Description
com.ibm.cloud.sdk.core.http.ServiceCall<RatelimitResp>	createZoneRateLimits()	Create rate limit.
com.ibm.cloud.sdk.core.http.ServiceCall<RatelimitResp>	createZoneRateLimits(CreateZoneRateLimitsOptions createZoneRateLimitsOptions)	Create rate limit.
com.ibm.cloud.sdk.core.http.ServiceCall<DeleteRateLimitResp>	deleteZoneRateLimit(DeleteZoneRateLimitOptions deleteZoneRateLimitOptions)	Delete rate limit.
String	getCrn()	Gets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<RatelimitResp>	getRateLimit(GetRateLimitOptions getRateLimitOptions)	Get a rate limit.
String	getZoneIdentifier()	Gets the zoneIdentifier.
com.ibm.cloud.sdk.core.http.ServiceCall<ListRatelimitResp>	listAllZoneRateLimits()	List all rate limits.
com.ibm.cloud.sdk.core.http.ServiceCall<ListRatelimitResp>	listAllZoneRateLimits(ListAllZoneRateLimitsOptions listAllZoneRateLimitsOptions)	List all rate limits.
static ZoneRateLimits	newInstance(String crn, String zoneIdentifier)	Class method which constructs an instance of the `ZoneRateLimits` client.
static ZoneRateLimits	newInstance(String crn, String zoneIdentifier, String serviceName)	Class method which constructs an instance of the `ZoneRateLimits` client.
void	setCrn(String crn)	Sets the crn.
void	setZoneIdentifier(String zoneIdentifier)	Sets the zoneIdentifier.
com.ibm.cloud.sdk.core.http.ServiceCall<RatelimitResp>	updateRateLimit(UpdateRateLimitOptions updateRateLimitOptions)	Update rate limit.

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

ZoneRateLimits

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

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

Parameters:

crn - Full crn of the service instance.

zoneIdentifier - Zone identifier (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 ZoneRateLimits newInstance(String crn,
                                         String zoneIdentifier)

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

Parameters:

crn - Full crn of the service instance.

zoneIdentifier - Zone identifier (zone id).

Returns:

an instance of the `ZoneRateLimits` client using external configuration

newInstance

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

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

Parameters:

crn - Full crn of the service instance.

zoneIdentifier - Zone identifier (zone id).

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

Returns:

an instance of the `ZoneRateLimits` client using external configuration

getCrn

public String getCrn()

Gets the crn. Full crn of the service 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 (zone id).

Returns:

the zoneIdentifier

setZoneIdentifier

public void setZoneIdentifier(String zoneIdentifier)

Sets the zoneIdentifier.

Parameters:

zoneIdentifier - the new zoneIdentifier

listAllZoneRateLimits

public com.ibm.cloud.sdk.core.http.ServiceCall<ListRatelimitResp> listAllZoneRateLimits(ListAllZoneRateLimitsOptions listAllZoneRateLimitsOptions)

List all rate limits. The details of Rate Limit for a given zone under a given service instance.

Parameters:

listAllZoneRateLimitsOptions - the ListAllZoneRateLimitsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListRatelimitResp

listAllZoneRateLimits

public com.ibm.cloud.sdk.core.http.ServiceCall<ListRatelimitResp> listAllZoneRateLimits()

List all rate limits. The details of Rate Limit for a given zone under a given service instance.

Returns:

a ServiceCall with a result of type ListRatelimitResp

createZoneRateLimits

public com.ibm.cloud.sdk.core.http.ServiceCall<RatelimitResp> createZoneRateLimits(CreateZoneRateLimitsOptions createZoneRateLimitsOptions)

Create rate limit. Create a new rate limit for a given zone under a service instance.

Parameters:

createZoneRateLimitsOptions - the CreateZoneRateLimitsOptions containing the options for the call

Returns:

a ServiceCall with a result of type RatelimitResp

createZoneRateLimits

public com.ibm.cloud.sdk.core.http.ServiceCall<RatelimitResp> createZoneRateLimits()

Create rate limit. Create a new rate limit for a given zone under a service instance.

Returns:

a ServiceCall with a result of type RatelimitResp

deleteZoneRateLimit

public com.ibm.cloud.sdk.core.http.ServiceCall<DeleteRateLimitResp> deleteZoneRateLimit(DeleteZoneRateLimitOptions deleteZoneRateLimitOptions)

Delete rate limit. Delete a rate limit given its id.

Parameters:

deleteZoneRateLimitOptions - the DeleteZoneRateLimitOptions containing the options for the call

Returns:

a ServiceCall with a result of type DeleteRateLimitResp

getRateLimit

public com.ibm.cloud.sdk.core.http.ServiceCall<RatelimitResp> getRateLimit(GetRateLimitOptions getRateLimitOptions)

Get a rate limit. Get the details of a rate limit for a given zone under a given service instance.

Parameters:

getRateLimitOptions - the GetRateLimitOptions containing the options for the call

Returns:

a ServiceCall with a result of type RatelimitResp

updateRateLimit

public com.ibm.cloud.sdk.core.http.ServiceCall<RatelimitResp> updateRateLimit(UpdateRateLimitOptions updateRateLimitOptions)

Update rate limit. Update an existing rate limit for a given zone under a service instance.

Parameters:

updateRateLimitOptions - the UpdateRateLimitOptions containing the options for the call

Returns:

a ServiceCall with a result of type RatelimitResp