Package com.ibm.cloud.networking.custom_pages.v1

Class CustomPages

java.lang.Object

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

com.ibm.cloud.networking.custom_pages.v1.CustomPages

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

Custom Pages.

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

Method Summary

Modifier and Type	Method	Description
String	getCrn()	Gets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<CustomPageSpecificResp>	getInstanceCustomPage(GetInstanceCustomPageOptions getInstanceCustomPageOptions)	Get a custom page for a given instance.
com.ibm.cloud.sdk.core.http.ServiceCall<CustomPageSpecificResp>	getZoneCustomPage(GetZoneCustomPageOptions getZoneCustomPageOptions)	Get a custom page for a given zone.
String	getZoneIdentifier()	Gets the zoneIdentifier.
com.ibm.cloud.sdk.core.http.ServiceCall<ListCustomPagesResp>	listInstanceCustomPages()	List all custom pages for a given instance.
com.ibm.cloud.sdk.core.http.ServiceCall<ListCustomPagesResp>	listInstanceCustomPages(ListInstanceCustomPagesOptions listInstanceCustomPagesOptions)	List all custom pages for a given instance.
com.ibm.cloud.sdk.core.http.ServiceCall<ListCustomPagesResp>	listZoneCustomPages()	List all custom pages for a given zone.
com.ibm.cloud.sdk.core.http.ServiceCall<ListCustomPagesResp>	listZoneCustomPages(ListZoneCustomPagesOptions listZoneCustomPagesOptions)	List all custom pages for a given zone.
static CustomPages	newInstance(String crn, String zoneIdentifier)	Class method which constructs an instance of the `CustomPages` client.
static CustomPages	newInstance(String crn, String zoneIdentifier, String serviceName)	Class method which constructs an instance of the `CustomPages` client.
void	setCrn(String crn)	Sets the crn.
void	setZoneIdentifier(String zoneIdentifier)	Sets the zoneIdentifier.
com.ibm.cloud.sdk.core.http.ServiceCall<CustomPageSpecificResp>	updateInstanceCustomPage(UpdateInstanceCustomPageOptions updateInstanceCustomPageOptions)	Update a custom page for a given instance.
com.ibm.cloud.sdk.core.http.ServiceCall<CustomPageSpecificResp>	updateZoneCustomPage(UpdateZoneCustomPageOptions updateZoneCustomPageOptions)	Update a custom page for a given zone.

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

CustomPages

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

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

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

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

Returns:

an instance of the `CustomPages` client using external configuration

newInstance

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

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

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

Returns:

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

Returns:

the zoneIdentifier

setZoneIdentifier

public void setZoneIdentifier(String zoneIdentifier)

Sets the zoneIdentifier.

Parameters:

zoneIdentifier - the new zoneIdentifier

listInstanceCustomPages

public com.ibm.cloud.sdk.core.http.ServiceCall<ListCustomPagesResp> listInstanceCustomPages(ListInstanceCustomPagesOptions listInstanceCustomPagesOptions)

List all custom pages for a given instance. List all custom pages for a given instance.

Parameters:

listInstanceCustomPagesOptions - the ListInstanceCustomPagesOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListCustomPagesResp

listInstanceCustomPages

public com.ibm.cloud.sdk.core.http.ServiceCall<ListCustomPagesResp> listInstanceCustomPages()

List all custom pages for a given instance. List all custom pages for a given instance.

Returns:

a ServiceCall with a result of type ListCustomPagesResp

getInstanceCustomPage

public com.ibm.cloud.sdk.core.http.ServiceCall<CustomPageSpecificResp> getInstanceCustomPage(GetInstanceCustomPageOptions getInstanceCustomPageOptions)

Get a custom page for a given instance. Get a specific custom page for a given instance.

Parameters:

getInstanceCustomPageOptions - the GetInstanceCustomPageOptions containing the options for the call

Returns:

a ServiceCall with a result of type CustomPageSpecificResp

updateInstanceCustomPage

public com.ibm.cloud.sdk.core.http.ServiceCall<CustomPageSpecificResp> updateInstanceCustomPage(UpdateInstanceCustomPageOptions updateInstanceCustomPageOptions)

Update a custom page for a given instance. Update a specific custom page for a given instance.

Parameters:

updateInstanceCustomPageOptions - the UpdateInstanceCustomPageOptions containing the options for the call

Returns:

a ServiceCall with a result of type CustomPageSpecificResp

listZoneCustomPages

public com.ibm.cloud.sdk.core.http.ServiceCall<ListCustomPagesResp> listZoneCustomPages(ListZoneCustomPagesOptions listZoneCustomPagesOptions)

List all custom pages for a given zone. List all custom pages for a given zone.

Parameters:

listZoneCustomPagesOptions - the ListZoneCustomPagesOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListCustomPagesResp

listZoneCustomPages

public com.ibm.cloud.sdk.core.http.ServiceCall<ListCustomPagesResp> listZoneCustomPages()

List all custom pages for a given zone. List all custom pages for a given zone.

Returns:

a ServiceCall with a result of type ListCustomPagesResp

getZoneCustomPage

public com.ibm.cloud.sdk.core.http.ServiceCall<CustomPageSpecificResp> getZoneCustomPage(GetZoneCustomPageOptions getZoneCustomPageOptions)

Get a custom page for a given zone. Get a specific custom page for a given zone.

Parameters:

getZoneCustomPageOptions - the GetZoneCustomPageOptions containing the options for the call

Returns:

a ServiceCall with a result of type CustomPageSpecificResp

updateZoneCustomPage

public com.ibm.cloud.sdk.core.http.ServiceCall<CustomPageSpecificResp> updateZoneCustomPage(UpdateZoneCustomPageOptions updateZoneCustomPageOptions)

Update a custom page for a given zone. Update a specific custom page for a given zone.

Parameters:

updateZoneCustomPageOptions - the UpdateZoneCustomPageOptions containing the options for the call

Returns:

a ServiceCall with a result of type CustomPageSpecificResp