Package com.oracle.bmc.visualbuilder

Class VbInstanceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.visualbuilder.VbInstanceClient

All Implemented Interfaces:

VbInstance, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210601")
public class VbInstanceClient
extends BaseSyncClient
implements VbInstance

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VbInstanceClient.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 VbInstance.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VbInstanceClient.Builder	builder()	Create a builder for this client.
ChangeVbInstanceCompartmentResponse	changeVbInstanceCompartment(ChangeVbInstanceCompartmentRequest request)	Change the compartment for an vb instance
void	close()
CreateVbInstanceResponse	createVbInstance(CreateVbInstanceRequest request)	Creates a new Vb Instance.
DeleteVbInstanceResponse	deleteVbInstance(DeleteVbInstanceRequest request)	Deletes an Vb Instance resource by identifier.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
VbInstancePaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetVbInstanceResponse	getVbInstance(GetVbInstanceRequest request)	Gets a VbInstance by identifier
VbInstanceWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Gets the status of the work request with the given ID.
ListVbInstancesResponse	listVbInstances(ListVbInstancesRequest request)	Returns a list of Vb 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)	Lists the 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.
ReconfigurePrivateEndpointVbInstanceResponse	reconfigurePrivateEndpointVbInstance(ReconfigurePrivateEndpointVbInstanceRequest request)	Reconfigures the Private Endpoint associated with the private visual builder instance.
void	refreshClient()	Rebuild the backing HttpClient.
RequestSummarizedApplicationsResponse	requestSummarizedApplications(RequestSummarizedApplicationsRequest request)	Summarizes the applications for a vb instance.
void	setEndpoint(String endpoint)
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’).
StartVbInstanceResponse	startVbInstance(StartVbInstanceRequest request)	Start an vb instance that was previously in an INACTIVE state.
StopVbInstanceResponse	stopVbInstance(StopVbInstanceRequest request)	Stop an vb instance that was previously in an ACTIVE state.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateVbInstanceResponse	updateVbInstance(UpdateVbInstanceRequest request)	Updates the Vb Instance.
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.visualbuilder.VbInstance

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for VbInstance.

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

VbInstanceClient

@Deprecated
public VbInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

VbInstanceClient

@Deprecated
public VbInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

VbInstanceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

VbInstanceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

VbInstanceClient

@Deprecated
public VbInstanceClient(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 VbInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

VbInstanceClient

@Deprecated
public VbInstanceClient(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 VbInstanceClient.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)

VbInstanceClient

@Deprecated
public VbInstanceClient(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 VbInstanceClient.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

VbInstanceClient

@Deprecated
public VbInstanceClient(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 VbInstanceClient.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 - VbInstanceClient.Builder.executorService

Method Detail

builder

public static VbInstanceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: VbInstance

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 VbInstance

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: VbInstance

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 VbInstance

Parameters:

regionId - The public region ID.

changeVbInstanceCompartment

public ChangeVbInstanceCompartmentResponse changeVbInstanceCompartment(ChangeVbInstanceCompartmentRequest request)

Description copied from interface: VbInstance

Change the compartment for an vb instance

Specified by:

changeVbInstanceCompartment in interface VbInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createVbInstance

public CreateVbInstanceResponse createVbInstance(CreateVbInstanceRequest request)

Description copied from interface: VbInstance

Creates a new Vb Instance.

Specified by:

createVbInstance in interface VbInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteVbInstance

public DeleteVbInstanceResponse deleteVbInstance(DeleteVbInstanceRequest request)

Description copied from interface: VbInstance

Deletes an Vb Instance resource by identifier.

Specified by:

deleteVbInstance in interface VbInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVbInstance

public GetVbInstanceResponse getVbInstance(GetVbInstanceRequest request)

Description copied from interface: VbInstance

Gets a VbInstance by identifier

Specified by:

getVbInstance in interface VbInstance

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: VbInstance

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface VbInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listVbInstances

public ListVbInstancesResponse listVbInstances(ListVbInstancesRequest request)

Description copied from interface: VbInstance

Returns a list of Vb Instances.

Specified by:

listVbInstances in interface VbInstance

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: VbInstance

Get the errors of a work request.

Specified by:

listWorkRequestErrors in interface VbInstance

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: VbInstance

Get the logs of a work request.

Specified by:

listWorkRequestLogs in interface VbInstance

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: VbInstance

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface VbInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

reconfigurePrivateEndpointVbInstance

public ReconfigurePrivateEndpointVbInstanceResponse reconfigurePrivateEndpointVbInstance(ReconfigurePrivateEndpointVbInstanceRequest request)

Description copied from interface: VbInstance

Reconfigures the Private Endpoint associated with the private visual builder instance.

Use this action in case the Private Endpoint is not working and needs to be reset. The VB instance has to be in ACTIVE state and should be a private instance to perform this operation. If the previous state is not ACTIVE, then the state of the vbInstance will not be changed and a 409 response returned.

Specified by:

reconfigurePrivateEndpointVbInstance in interface VbInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

requestSummarizedApplications

public RequestSummarizedApplicationsResponse requestSummarizedApplications(RequestSummarizedApplicationsRequest request)

Description copied from interface: VbInstance

Summarizes the applications for a vb instance.

Specified by:

requestSummarizedApplications in interface VbInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startVbInstance

public StartVbInstanceResponse startVbInstance(StartVbInstanceRequest request)

Description copied from interface: VbInstance

Start an vb instance that was previously in an INACTIVE state.

If the previous state is not INACTIVE, then the state of the vbInstance will not be changed and a 409 response returned.

Specified by:

startVbInstance in interface VbInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopVbInstance

public StopVbInstanceResponse stopVbInstance(StopVbInstanceRequest request)

Description copied from interface: VbInstance

Stop an vb instance that was previously in an ACTIVE state.

If the previous state is not ACTIVE, then the state of the vbInstance will not be changed and a 409 response returned.

Specified by:

stopVbInstance in interface VbInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateVbInstance

public UpdateVbInstanceResponse updateVbInstance(UpdateVbInstanceRequest request)

Description copied from interface: VbInstance

Updates the Vb Instance.

Specified by:

updateVbInstance in interface VbInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public VbInstanceWaiters getWaiters()

Description copied from interface: VbInstance

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

Specified by:

getWaiters in interface VbInstance

Returns:

The service waiters.

getPaginators

public VbInstancePaginators getPaginators()

Description copied from interface: VbInstance

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 VbInstance

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()