Package com.oracle.bmc.analytics

Class AnalyticsClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.analytics.AnalyticsClient

All Implemented Interfaces:

Analytics, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190331")
public class AnalyticsClient
extends BaseSyncClient
implements Analytics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnalyticsClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for Analytics.

Constructor Summary

Constructors

Constructor	Description
AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
AnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
AnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
AnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static AnalyticsClient.Builder	builder()	Create a builder for this client.
ChangeAnalyticsInstanceCompartmentResponse	changeAnalyticsInstanceCompartment(ChangeAnalyticsInstanceCompartmentRequest request)	Change the compartment of an Analytics instance.
ChangeAnalyticsInstanceNetworkEndpointResponse	changeAnalyticsInstanceNetworkEndpoint(ChangeAnalyticsInstanceNetworkEndpointRequest request)	Change an Analytics instance network endpoint.
void	close()
CreateAnalyticsInstanceResponse	createAnalyticsInstance(CreateAnalyticsInstanceRequest request)	Create a new AnalyticsInstance in the specified compartment.
CreatePrivateAccessChannelResponse	createPrivateAccessChannel(CreatePrivateAccessChannelRequest request)	Create an Private access Channel for the Analytics instance.
CreateVanityUrlResponse	createVanityUrl(CreateVanityUrlRequest request)	Allows specifying a custom host name to be used to access the analytics instance.
DeleteAnalyticsInstanceResponse	deleteAnalyticsInstance(DeleteAnalyticsInstanceRequest request)	Terminates the specified Analytics instance.
DeletePrivateAccessChannelResponse	deletePrivateAccessChannel(DeletePrivateAccessChannelRequest request)	Delete an Analytics instance’s Private access channel with the given unique identifier key.
DeleteVanityUrlResponse	deleteVanityUrl(DeleteVanityUrlRequest request)	Allows deleting a previously created vanity url.
DeleteWorkRequestResponse	deleteWorkRequest(DeleteWorkRequestRequest request)	Cancel a work request that has not started yet.
GetAnalyticsInstanceResponse	getAnalyticsInstance(GetAnalyticsInstanceRequest request)	Info for a specific Analytics instance.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
AnalyticsPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPrivateAccessChannelResponse	getPrivateAccessChannel(GetPrivateAccessChannelRequest request)	Retrieve private access channel in the specified Analytics Instance.
AnalyticsWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Get the details of a work request.
ListAnalyticsInstancesResponse	listAnalyticsInstances(ListAnalyticsInstancesRequest request)	List Analytics instances.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	Get the errors of a work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Get the logs of a work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request)	List all work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
ScaleAnalyticsInstanceResponse	scaleAnalyticsInstance(ScaleAnalyticsInstanceRequest request)	Scale an Analytics instance up or down.
void	setEndpoint(String endpoint)
SetFeatureBundleResponse	setFeatureBundle(SetFeatureBundleRequest request)	Set the external service properties of an Analytics instance.
SetKmsKeyResponse	setKmsKey(SetKmsKeyRequest request)	Encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key.
void	setRegion(Region region)	Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId)	Sets the region to call (ex, ‘us-phoenix-1’).
StartAnalyticsInstanceResponse	startAnalyticsInstance(StartAnalyticsInstanceRequest request)	Starts the specified Analytics instance.
StopAnalyticsInstanceResponse	stopAnalyticsInstance(StopAnalyticsInstanceRequest request)	Stop the specified Analytics instance.
UpdateAnalyticsInstanceResponse	updateAnalyticsInstance(UpdateAnalyticsInstanceRequest request)	Updates certain fields of an Analytics instance.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdatePrivateAccessChannelResponse	updatePrivateAccessChannel(UpdatePrivateAccessChannelRequest request)	Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.
UpdateVanityUrlResponse	updateVanityUrl(UpdateVanityUrlRequest request)	Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.analytics.Analytics

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Analytics.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

AnalyticsClient

@Deprecated
public AnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

AnalyticsClient

@Deprecated
public AnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

AnalyticsClient

@Deprecated
public AnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

AnalyticsClient

@Deprecated
public AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

AnalyticsClient

@Deprecated
public AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

AnalyticsClient

@Deprecated
public AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

AnalyticsClient

@Deprecated
public AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

AnalyticsClient

@Deprecated
public AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint,
                       ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - AnalyticsClient.Builder.executorService

Method Detail

builder

public static AnalyticsClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Analytics

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface Analytics

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Analytics

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface Analytics

Parameters:

regionId - The public region ID.

changeAnalyticsInstanceCompartment

public ChangeAnalyticsInstanceCompartmentResponse changeAnalyticsInstanceCompartment(ChangeAnalyticsInstanceCompartmentRequest request)

Description copied from interface: Analytics

Change the compartment of an Analytics instance.

The operation is long-running and creates a new WorkRequest.

Specified by:

changeAnalyticsInstanceCompartment in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeAnalyticsInstanceNetworkEndpoint

public ChangeAnalyticsInstanceNetworkEndpointResponse changeAnalyticsInstanceNetworkEndpoint(ChangeAnalyticsInstanceNetworkEndpointRequest request)

Description copied from interface: Analytics

Change an Analytics instance network endpoint.

The operation is long-running and creates a new WorkRequest.

Specified by:

changeAnalyticsInstanceNetworkEndpoint in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createAnalyticsInstance

public CreateAnalyticsInstanceResponse createAnalyticsInstance(CreateAnalyticsInstanceRequest request)

Description copied from interface: Analytics

Create a new AnalyticsInstance in the specified compartment.

The operation is long-running and creates a new WorkRequest.

Specified by:

createAnalyticsInstance in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createPrivateAccessChannel

public CreatePrivateAccessChannelResponse createPrivateAccessChannel(CreatePrivateAccessChannelRequest request)

Description copied from interface: Analytics

Create an Private access Channel for the Analytics instance.

The operation is long-running and creates a new WorkRequest.

Specified by:

createPrivateAccessChannel in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createVanityUrl

public CreateVanityUrlResponse createVanityUrl(CreateVanityUrlRequest request)

Description copied from interface: Analytics

Allows specifying a custom host name to be used to access the analytics instance.

This requires prior setup of DNS entry and certificate for this host.

Specified by:

createVanityUrl in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteAnalyticsInstance

public DeleteAnalyticsInstanceResponse deleteAnalyticsInstance(DeleteAnalyticsInstanceRequest request)

Description copied from interface: Analytics

Terminates the specified Analytics instance.

The operation is long-running and creates a new WorkRequest.

Specified by:

deleteAnalyticsInstance in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deletePrivateAccessChannel

public DeletePrivateAccessChannelResponse deletePrivateAccessChannel(DeletePrivateAccessChannelRequest request)

Description copied from interface: Analytics

Delete an Analytics instance’s Private access channel with the given unique identifier key.

Specified by:

deletePrivateAccessChannel in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteVanityUrl

public DeleteVanityUrlResponse deleteVanityUrl(DeleteVanityUrlRequest request)

Description copied from interface: Analytics

Allows deleting a previously created vanity url.

Specified by:

deleteVanityUrl in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteWorkRequest

public DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)

Description copied from interface: Analytics

Cancel a work request that has not started yet.

Specified by:

deleteWorkRequest in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAnalyticsInstance

public GetAnalyticsInstanceResponse getAnalyticsInstance(GetAnalyticsInstanceRequest request)

Description copied from interface: Analytics

Info for a specific Analytics instance.

Specified by:

getAnalyticsInstance in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPrivateAccessChannel

public GetPrivateAccessChannelResponse getPrivateAccessChannel(GetPrivateAccessChannelRequest request)

Description copied from interface: Analytics

Retrieve private access channel in the specified Analytics Instance.

Specified by:

getPrivateAccessChannel in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: Analytics

Get the details of a work request.

Specified by:

getWorkRequest in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAnalyticsInstances

public ListAnalyticsInstancesResponse listAnalyticsInstances(ListAnalyticsInstancesRequest request)

Description copied from interface: Analytics

List Analytics instances.

Specified by:

listAnalyticsInstances in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: Analytics

Get the errors of a work request.

Specified by:

listWorkRequestErrors in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: Analytics

Get the logs of a work request.

Specified by:

listWorkRequestLogs in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: Analytics

List all work requests in a compartment.

Specified by:

listWorkRequests in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

scaleAnalyticsInstance

public ScaleAnalyticsInstanceResponse scaleAnalyticsInstance(ScaleAnalyticsInstanceRequest request)

Description copied from interface: Analytics

Scale an Analytics instance up or down.

The operation is long-running and creates a new WorkRequest.

Specified by:

scaleAnalyticsInstance in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

setFeatureBundle

public SetFeatureBundleResponse setFeatureBundle(SetFeatureBundleRequest request)

Description copied from interface: Analytics

Set the external service properties of an Analytics instance.

Specified by:

setFeatureBundle in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

setKmsKey

public SetKmsKeyResponse setKmsKey(SetKmsKeyRequest request)

Description copied from interface: Analytics

Encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key.

Specified by:

setKmsKey in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startAnalyticsInstance

public StartAnalyticsInstanceResponse startAnalyticsInstance(StartAnalyticsInstanceRequest request)

Description copied from interface: Analytics

Starts the specified Analytics instance.

The operation is long-running and creates a new WorkRequest.

Specified by:

startAnalyticsInstance in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopAnalyticsInstance

public StopAnalyticsInstanceResponse stopAnalyticsInstance(StopAnalyticsInstanceRequest request)

Description copied from interface: Analytics

Stop the specified Analytics instance.

The operation is long-running and creates a new WorkRequest.

Specified by:

stopAnalyticsInstance in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAnalyticsInstance

public UpdateAnalyticsInstanceResponse updateAnalyticsInstance(UpdateAnalyticsInstanceRequest request)

Description copied from interface: Analytics

Updates certain fields of an Analytics instance.

Fields that are not provided in the request will not be updated.

Specified by:

updateAnalyticsInstance in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updatePrivateAccessChannel

public UpdatePrivateAccessChannelResponse updatePrivateAccessChannel(UpdatePrivateAccessChannelRequest request)

Description copied from interface: Analytics

Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.

Specified by:

updatePrivateAccessChannel in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateVanityUrl

public UpdateVanityUrlResponse updateVanityUrl(UpdateVanityUrlRequest request)

Description copied from interface: Analytics

Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.

Specified by:

updateVanityUrl in interface Analytics

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public AnalyticsWaiters getWaiters()

Description copied from interface: Analytics

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface Analytics

Returns:

The service waiters.

getPaginators

public AnalyticsPaginators getPaginators()

Description copied from interface: Analytics

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface Analytics

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()