@Generated(value="OracleSDKGenerator", comments="API Version: 20190331") public class AnalyticsClient extends Object implements Analytics
Modifier and Type | Class and Description |
---|---|
static class |
AnalyticsClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Analytics.
|
Modifier | Constructor and Description |
---|---|
|
AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
AnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
AnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
AnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and 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 |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
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.
|
ScaleAnalyticsInstanceResponse |
scaleAnalyticsInstance(ScaleAnalyticsInstanceRequest request)
Scale an Analytics instance up or down.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
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.
|
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.
|
public static final Service SERVICE
Service instance for Analytics.
public AnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public AnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public AnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected AnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the AnalyticsClient.Builder
to get access to all these parameters.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static AnalyticsClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
Analytics
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface Analytics
endpoint
- The endpoint of the service.public String getEndpoint()
Analytics
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface Analytics
public void setRegion(Region region)
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.
public void setRegion(String regionId)
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
.
public void close()
close
in interface AutoCloseable
public ChangeAnalyticsInstanceCompartmentResponse changeAnalyticsInstanceCompartment(ChangeAnalyticsInstanceCompartmentRequest request)
Analytics
Change the compartment of an Analytics instance. The operation is long-running and creates a new WorkRequest.
changeAnalyticsInstanceCompartment
in interface Analytics
request
- The request object containing the details to sendpublic ChangeAnalyticsInstanceNetworkEndpointResponse changeAnalyticsInstanceNetworkEndpoint(ChangeAnalyticsInstanceNetworkEndpointRequest request)
Analytics
Change an Analytics instance network endpoint. The operation is long-running and creates a new WorkRequest.
changeAnalyticsInstanceNetworkEndpoint
in interface Analytics
request
- The request object containing the details to sendpublic CreateAnalyticsInstanceResponse createAnalyticsInstance(CreateAnalyticsInstanceRequest request)
Analytics
Create a new AnalyticsInstance in the specified compartment. The operation is long-running and creates a new WorkRequest.
createAnalyticsInstance
in interface Analytics
request
- The request object containing the details to sendpublic CreatePrivateAccessChannelResponse createPrivateAccessChannel(CreatePrivateAccessChannelRequest request)
Analytics
Create an Private access Channel for the Analytics instance. The operation is long-running and creates a new WorkRequest.
createPrivateAccessChannel
in interface Analytics
request
- The request object containing the details to sendpublic CreateVanityUrlResponse createVanityUrl(CreateVanityUrlRequest request)
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.
createVanityUrl
in interface Analytics
request
- The request object containing the details to sendpublic DeleteAnalyticsInstanceResponse deleteAnalyticsInstance(DeleteAnalyticsInstanceRequest request)
Analytics
Terminates the specified Analytics instance. The operation is long-running and creates a new WorkRequest.
deleteAnalyticsInstance
in interface Analytics
request
- The request object containing the details to sendpublic DeletePrivateAccessChannelResponse deletePrivateAccessChannel(DeletePrivateAccessChannelRequest request)
Analytics
Delete an Analytics instance’s Private access channel with the given unique identifier key.
deletePrivateAccessChannel
in interface Analytics
request
- The request object containing the details to sendpublic DeleteVanityUrlResponse deleteVanityUrl(DeleteVanityUrlRequest request)
Analytics
Allows deleting a previously created vanity url.
deleteVanityUrl
in interface Analytics
request
- The request object containing the details to sendpublic DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)
Analytics
Cancel a work request that has not started yet.
deleteWorkRequest
in interface Analytics
request
- The request object containing the details to sendpublic GetAnalyticsInstanceResponse getAnalyticsInstance(GetAnalyticsInstanceRequest request)
Analytics
Info for a specific Analytics instance.
getAnalyticsInstance
in interface Analytics
request
- The request object containing the details to sendpublic GetPrivateAccessChannelResponse getPrivateAccessChannel(GetPrivateAccessChannelRequest request)
Analytics
Retrieve private access channel in the specified Analytics Instance.
getPrivateAccessChannel
in interface Analytics
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Analytics
Get the details of a work request.
getWorkRequest
in interface Analytics
request
- The request object containing the details to sendpublic ListAnalyticsInstancesResponse listAnalyticsInstances(ListAnalyticsInstancesRequest request)
Analytics
List Analytics instances.
listAnalyticsInstances
in interface Analytics
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Analytics
Get the errors of a work request.
listWorkRequestErrors
in interface Analytics
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Analytics
Get the logs of a work request.
listWorkRequestLogs
in interface Analytics
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Analytics
List all work requests in a compartment.
listWorkRequests
in interface Analytics
request
- The request object containing the details to sendpublic ScaleAnalyticsInstanceResponse scaleAnalyticsInstance(ScaleAnalyticsInstanceRequest request)
Analytics
Scale an Analytics instance up or down. The operation is long-running and creates a new WorkRequest.
scaleAnalyticsInstance
in interface Analytics
request
- The request object containing the details to sendpublic StartAnalyticsInstanceResponse startAnalyticsInstance(StartAnalyticsInstanceRequest request)
Analytics
Starts the specified Analytics instance. The operation is long-running and creates a new WorkRequest.
startAnalyticsInstance
in interface Analytics
request
- The request object containing the details to sendpublic StopAnalyticsInstanceResponse stopAnalyticsInstance(StopAnalyticsInstanceRequest request)
Analytics
Stop the specified Analytics instance. The operation is long-running and creates a new WorkRequest.
stopAnalyticsInstance
in interface Analytics
request
- The request object containing the details to sendpublic UpdateAnalyticsInstanceResponse updateAnalyticsInstance(UpdateAnalyticsInstanceRequest request)
Analytics
Updates certain fields of an Analytics instance. Fields that are not provided in the request will not be updated.
updateAnalyticsInstance
in interface Analytics
request
- The request object containing the details to sendpublic UpdatePrivateAccessChannelResponse updatePrivateAccessChannel(UpdatePrivateAccessChannelRequest request)
Analytics
Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.
updatePrivateAccessChannel
in interface Analytics
request
- The request object containing the details to sendpublic UpdateVanityUrlResponse updateVanityUrl(UpdateVanityUrlRequest request)
Analytics
Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.
updateVanityUrl
in interface Analytics
request
- The request object containing the details to sendpublic AnalyticsWaiters getWaiters()
Analytics
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface Analytics
public AnalyticsPaginators getPaginators()
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.
getPaginators
in interface Analytics
Copyright © 2016–2021. All rights reserved.