Class GuardedDataPipelineClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.gdp.GuardedDataPipelineClient
-
- All Implemented Interfaces:
GuardedDataPipeline,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20230301") public class GuardedDataPipelineClient extends BaseSyncClient implements GuardedDataPipeline
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGuardedDataPipelineClient.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 GuardedDataPipeline.
-
Constructor Summary
Constructors Constructor Description GuardedDataPipelineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.GuardedDataPipelineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.GuardedDataPipelineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.GuardedDataPipelineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.GuardedDataPipelineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.GuardedDataPipelineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.GuardedDataPipelineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.GuardedDataPipelineClient(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 GuardedDataPipelineClient.Builderbuilder()Create a builder for this client.ChangeGdpPipelineCompartmentResponsechangeGdpPipelineCompartment(ChangeGdpPipelineCompartmentRequest request)Moves a pipeline resource from one compartment to another.voidclose()CreateGdpPipelineResponsecreateGdpPipeline(CreateGdpPipelineRequest request)Creates a new pipeline.DeleteGdpPipelineResponsedeleteGdpPipeline(DeleteGdpPipelineRequest request)Deletes a pipeline 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.GetGdpPipelineResponsegetGdpPipeline(GetGdpPipelineRequest request)Retrieves a pipeline by identifier.GetGdpWorkRequestResponsegetGdpWorkRequest(GetGdpWorkRequestRequest request)Gets details of the work request with the given ID.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.GuardedDataPipelinePaginatorsgetPaginators()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.GuardedDataPipelineWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListGdpPipelinesResponselistGdpPipelines(ListGdpPipelinesRequest request)Returns a list of pipelines.ListGdpWorkRequestErrorsResponselistGdpWorkRequestErrors(ListGdpWorkRequestErrorsRequest request)Returns a (paginated) list of errors for the work request with the given ID.ListGdpWorkRequestLogsResponselistGdpWorkRequestLogs(ListGdpWorkRequestLogsRequest request)Returns a (paginated) list of logs for the work request with the given ID.ListGdpWorkRequestsResponselistGdpWorkRequests(ListGdpWorkRequestsRequest request)Lists the work requests in a compartment.PeerGdpPipelineResponsepeerGdpPipeline(PeerGdpPipelineRequest request)Peers the pipeline.voidrefreshClient()Rebuild the backingHttpClient.RotateGdpPipelineKeysResponserotateGdpPipelineKeys(RotateGdpPipelineKeysRequest request)Rotates the pipeline keys by resending the control message with a fresh pair of keys.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’).StartGdpPipelineResponsestartGdpPipeline(StartGdpPipelineRequest request)Starts the pipeline.StopGdpPipelineResponsestopGdpPipeline(StopGdpPipelineRequest request)Stops the pipeline.UpdateGdpPipelineResponseupdateGdpPipeline(UpdateGdpPipelineRequest request)Updates the pipeline.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.gdp.GuardedDataPipeline
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
GuardedDataPipelineClient
@Deprecated public GuardedDataPipelineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGuardedDataPipelineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
GuardedDataPipelineClient
@Deprecated public GuardedDataPipelineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGuardedDataPipelineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
GuardedDataPipelineClient
@Deprecated public GuardedDataPipelineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGuardedDataPipelineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
GuardedDataPipelineClient
@Deprecated public GuardedDataPipelineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGuardedDataPipelineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
GuardedDataPipelineClient
@Deprecated public GuardedDataPipelineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGuardedDataPipelineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
GuardedDataPipelineClient
@Deprecated public GuardedDataPipelineClient(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 (seeGuardedDataPipelineClient.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)
-
GuardedDataPipelineClient
@Deprecated public GuardedDataPipelineClient(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 (seeGuardedDataPipelineClient.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
-
GuardedDataPipelineClient
@Deprecated public GuardedDataPipelineClient(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 (seeGuardedDataPipelineClient.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-GuardedDataPipelineClient.Builder.executorService
-
-
Method Detail
-
builder
public static GuardedDataPipelineClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:GuardedDataPipelineSets 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 interfaceGuardedDataPipeline- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:GuardedDataPipelineSets 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 interfaceGuardedDataPipeline- Parameters:
regionId- The public region ID.
-
changeGdpPipelineCompartment
public ChangeGdpPipelineCompartmentResponse changeGdpPipelineCompartment(ChangeGdpPipelineCompartmentRequest request)
Description copied from interface:GuardedDataPipelineMoves a pipeline resource from one compartment to another.When provided, if-match is checked against etag values of the resource.
- Specified by:
changeGdpPipelineCompartmentin interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createGdpPipeline
public CreateGdpPipelineResponse createGdpPipeline(CreateGdpPipelineRequest request)
Description copied from interface:GuardedDataPipelineCreates a new pipeline.- Specified by:
createGdpPipelinein interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteGdpPipeline
public DeleteGdpPipelineResponse deleteGdpPipeline(DeleteGdpPipelineRequest request)
Description copied from interface:GuardedDataPipelineDeletes a pipeline by identifier.- Specified by:
deleteGdpPipelinein interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getGdpPipeline
public GetGdpPipelineResponse getGdpPipeline(GetGdpPipelineRequest request)
Description copied from interface:GuardedDataPipelineRetrieves a pipeline by identifier.- Specified by:
getGdpPipelinein interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getGdpWorkRequest
public GetGdpWorkRequestResponse getGdpWorkRequest(GetGdpWorkRequestRequest request)
Description copied from interface:GuardedDataPipelineGets details of the work request with the given ID.- Specified by:
getGdpWorkRequestin interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listGdpPipelines
public ListGdpPipelinesResponse listGdpPipelines(ListGdpPipelinesRequest request)
Description copied from interface:GuardedDataPipelineReturns a list of pipelines.- Specified by:
listGdpPipelinesin interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listGdpWorkRequestErrors
public ListGdpWorkRequestErrorsResponse listGdpWorkRequestErrors(ListGdpWorkRequestErrorsRequest request)
Description copied from interface:GuardedDataPipelineReturns a (paginated) list of errors for the work request with the given ID.- Specified by:
listGdpWorkRequestErrorsin interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listGdpWorkRequestLogs
public ListGdpWorkRequestLogsResponse listGdpWorkRequestLogs(ListGdpWorkRequestLogsRequest request)
Description copied from interface:GuardedDataPipelineReturns a (paginated) list of logs for the work request with the given ID.- Specified by:
listGdpWorkRequestLogsin interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listGdpWorkRequests
public ListGdpWorkRequestsResponse listGdpWorkRequests(ListGdpWorkRequestsRequest request)
Description copied from interface:GuardedDataPipelineLists the work requests in a compartment.- Specified by:
listGdpWorkRequestsin interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
peerGdpPipeline
public PeerGdpPipelineResponse peerGdpPipeline(PeerGdpPipelineRequest request)
Description copied from interface:GuardedDataPipelinePeers the pipeline.- Specified by:
peerGdpPipelinein interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
rotateGdpPipelineKeys
public RotateGdpPipelineKeysResponse rotateGdpPipelineKeys(RotateGdpPipelineKeysRequest request)
Description copied from interface:GuardedDataPipelineRotates the pipeline keys by resending the control message with a fresh pair of keys.- Specified by:
rotateGdpPipelineKeysin interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
startGdpPipeline
public StartGdpPipelineResponse startGdpPipeline(StartGdpPipelineRequest request)
Description copied from interface:GuardedDataPipelineStarts the pipeline.- Specified by:
startGdpPipelinein interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
stopGdpPipeline
public StopGdpPipelineResponse stopGdpPipeline(StopGdpPipelineRequest request)
Description copied from interface:GuardedDataPipelineStops the pipeline.- Specified by:
stopGdpPipelinein interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateGdpPipeline
public UpdateGdpPipelineResponse updateGdpPipeline(UpdateGdpPipelineRequest request)
Description copied from interface:GuardedDataPipelineUpdates the pipeline.- Specified by:
updateGdpPipelinein interfaceGuardedDataPipeline- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public GuardedDataPipelineWaiters getWaiters()
Description copied from interface:GuardedDataPipelineGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceGuardedDataPipeline- Returns:
- The service waiters.
-
getPaginators
public GuardedDataPipelinePaginators getPaginators()
Description copied from interface:GuardedDataPipelineGets 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 interfaceGuardedDataPipeline- 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()
-
-