Package com.ibm.cloud.networking.page_rule_api.v1

Class PageRuleApi

java.lang.Object

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

com.ibm.cloud.networking.page_rule_api.v1.PageRuleApi

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

This document describes CIS Pagerule 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
PageRuleApi(String crn, String zoneId, String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)	Constructs an instance of the `PageRuleApi` client.

Method Summary

Modifier and Type	Method	Description
com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseWithoutResultInfo>	changePageRule(ChangePageRuleOptions changePageRuleOptions)	Change page rule.
com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseWithoutResultInfo>	createPageRule()	Create page rule.
com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseWithoutResultInfo>	createPageRule(CreatePageRuleOptions createPageRuleOptions)	Create page rule.
com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesDeleteResponse>	deletePageRule(DeletePageRuleOptions deletePageRuleOptions)	Delete page rule.
String	getCrn()	Gets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseWithoutResultInfo>	getPageRule(GetPageRuleOptions getPageRuleOptions)	Get page rule.
String	getZoneId()	Gets the zoneId.
com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseListAll>	listPageRules()	List page rules.
com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseListAll>	listPageRules(ListPageRulesOptions listPageRulesOptions)	List page rules.
static PageRuleApi	newInstance(String crn, String zoneId)	Class method which constructs an instance of the `PageRuleApi` client.
static PageRuleApi	newInstance(String crn, String zoneId, String serviceName)	Class method which constructs an instance of the `PageRuleApi` client.
void	setCrn(String crn)	Sets the crn.
void	setZoneId(String zoneId)	Sets the zoneId.
com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseWithoutResultInfo>	updatePageRule(UpdatePageRuleOptions updatePageRuleOptions)	Update page rule.

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

PageRuleApi

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

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

Parameters:

crn - instance id.

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

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

Parameters:

crn - instance id.

zoneId - zone id.

Returns:

an instance of the `PageRuleApi` client using external configuration

newInstance

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

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

Parameters:

crn - instance id.

zoneId - zone id.

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

Returns:

an instance of the `PageRuleApi` client using external configuration

getCrn

public String getCrn()

Gets the crn. instance id.

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

Returns:

the zoneId

setZoneId

public void setZoneId(String zoneId)

Sets the zoneId.

Parameters:

zoneId - the new zoneId

getPageRule

public com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseWithoutResultInfo> getPageRule(GetPageRuleOptions getPageRuleOptions)

Get page rule. Get a page rule details.

Parameters:

getPageRuleOptions - the GetPageRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type PageRulesResponseWithoutResultInfo

changePageRule

public com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseWithoutResultInfo> changePageRule(ChangePageRuleOptions changePageRuleOptions)

Change page rule. Change a page rule.

Parameters:

changePageRuleOptions - the ChangePageRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type PageRulesResponseWithoutResultInfo

updatePageRule

public com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseWithoutResultInfo> updatePageRule(UpdatePageRuleOptions updatePageRuleOptions)

Update page rule. Replace a page rule. The final rule will exactly match the data passed with this request.

Parameters:

updatePageRuleOptions - the UpdatePageRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type PageRulesResponseWithoutResultInfo

deletePageRule

public com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesDeleteResponse> deletePageRule(DeletePageRuleOptions deletePageRuleOptions)

Delete page rule. Delete a page rule.

Parameters:

deletePageRuleOptions - the DeletePageRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type PageRulesDeleteResponse

listPageRules

public com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseListAll> listPageRules(ListPageRulesOptions listPageRulesOptions)

List page rules. List page rules.

Parameters:

listPageRulesOptions - the ListPageRulesOptions containing the options for the call

Returns:

a ServiceCall with a result of type PageRulesResponseListAll

listPageRules

public com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseListAll> listPageRules()

List page rules. List page rules.

Returns:

a ServiceCall with a result of type PageRulesResponseListAll

createPageRule

public com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseWithoutResultInfo> createPageRule(CreatePageRuleOptions createPageRuleOptions)

Create page rule. Create a page rule.

Parameters:

createPageRuleOptions - the CreatePageRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type PageRulesResponseWithoutResultInfo

createPageRule

public com.ibm.cloud.sdk.core.http.ServiceCall<PageRulesResponseWithoutResultInfo> createPageRule()

Create page rule. Create a page rule.

Returns:

a ServiceCall with a result of type PageRulesResponseWithoutResultInfo