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 classVbInstanceClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for VbInstance.
-
Constructor Summary
Constructors Constructor Description VbInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.VbInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.VbInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.VbInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.VbInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.VbInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.VbInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.VbInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VbInstanceClient.Builderbuilder()Create a builder for this client.ChangeVbInstanceCompartmentResponsechangeVbInstanceCompartment(ChangeVbInstanceCompartmentRequest request)Change the compartment for an vb instancevoidclose()CreateVbInstanceResponsecreateVbInstance(CreateVbInstanceRequest request)Creates a new Vb Instance.DeleteVbInstanceResponsedeleteVbInstance(DeleteVbInstanceRequest request)Deletes an Vb Instance resource by identifier.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.VbInstancePaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.GetVbInstanceResponsegetVbInstance(GetVbInstanceRequest request)Gets a VbInstance by identifierVbInstanceWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponsegetWorkRequest(GetWorkRequestRequest request)Gets the status of the work request with the given ID.ListVbInstancesResponselistVbInstances(ListVbInstancesRequest request)Returns a list of Vb Instances.ListWorkRequestErrorsResponselistWorkRequestErrors(ListWorkRequestErrorsRequest request)Get the errors of a work request.ListWorkRequestLogsResponselistWorkRequestLogs(ListWorkRequestLogsRequest request)Get the logs of a work request.ListWorkRequestsResponselistWorkRequests(ListWorkRequestsRequest request)Lists the work requests in a compartment.ReconfigurePrivateEndpointVbInstanceResponsereconfigurePrivateEndpointVbInstance(ReconfigurePrivateEndpointVbInstanceRequest request)Reconfigures the Private Endpoint associated with the private visual builder instance.voidrefreshClient()Rebuild the backingHttpClient.RequestSummarizedApplicationsResponserequestSummarizedApplications(RequestSummarizedApplicationsRequest request)Summarizes the applications for a vb instance.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).StartVbInstanceResponsestartVbInstance(StartVbInstanceRequest request)Start an vb instance that was previously in an INACTIVE state.StopVbInstanceResponsestopVbInstance(StopVbInstanceRequest request)Stop an vb instance that was previously in an ACTIVE state.UpdateVbInstanceResponseupdateVbInstance(UpdateVbInstanceRequest request)Updates the Vb Instance.voiduseRealmSpecificEndpointTemplate(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
-
-
-
-
Constructor Detail
-
VbInstanceClient
@Deprecated public VbInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeVbInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
VbInstanceClient
@Deprecated public VbInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeVbInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
VbInstanceClient
@Deprecated public VbInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeVbInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
VbInstanceClient
@Deprecated public VbInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeVbInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeVbInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
VbInstanceClient
@Deprecated public VbInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeVbInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeVbInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeVbInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-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:VbInstanceSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceVbInstance- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:VbInstanceSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceVbInstance- Parameters:
regionId- The public region ID.
-
changeVbInstanceCompartment
public ChangeVbInstanceCompartmentResponse changeVbInstanceCompartment(ChangeVbInstanceCompartmentRequest request)
Description copied from interface:VbInstanceChange the compartment for an vb instance- Specified by:
changeVbInstanceCompartmentin interfaceVbInstance- 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:VbInstanceCreates a new Vb Instance.- Specified by:
createVbInstancein interfaceVbInstance- 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:VbInstanceDeletes an Vb Instance resource by identifier.- Specified by:
deleteVbInstancein interfaceVbInstance- 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:VbInstanceGets a VbInstance by identifier- Specified by:
getVbInstancein interfaceVbInstance- 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:VbInstanceGets the status of the work request with the given ID.- Specified by:
getWorkRequestin interfaceVbInstance- 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:VbInstanceReturns a list of Vb Instances.- Specified by:
listVbInstancesin interfaceVbInstance- 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:VbInstanceGet the errors of a work request.- Specified by:
listWorkRequestErrorsin interfaceVbInstance- 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:VbInstanceGet the logs of a work request.- Specified by:
listWorkRequestLogsin interfaceVbInstance- 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:VbInstanceLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceVbInstance- 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:VbInstanceReconfigures 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:
reconfigurePrivateEndpointVbInstancein interfaceVbInstance- 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:VbInstanceSummarizes the applications for a vb instance.- Specified by:
requestSummarizedApplicationsin interfaceVbInstance- 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:VbInstanceStart 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:
startVbInstancein interfaceVbInstance- 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:VbInstanceStop 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:
stopVbInstancein interfaceVbInstance- 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:VbInstanceUpdates the Vb Instance.- Specified by:
updateVbInstancein interfaceVbInstance- 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:VbInstanceGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceVbInstance- Returns:
- The service waiters.
-
getPaginators
public VbInstancePaginators getPaginators()
Description copied from interface:VbInstanceGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceVbInstance- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-