@Generated(value="OracleSDKGenerator", comments="API Version: 20210527") public class ServiceCatalogClient extends Object implements ServiceCatalog
Modifier and Type | Class and Description |
---|---|
static class |
ServiceCatalogClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for ServiceCatalog.
|
Modifier | Constructor and Description |
---|---|
|
ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ServiceCatalogClient(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.
|
|
ServiceCatalogClient(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.
|
|
ServiceCatalogClient(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 |
ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ServiceCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
ServiceCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ServiceCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for ServiceCatalog.
public ServiceCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public ServiceCatalogClient(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 ServiceCatalogClient(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 ServiceCatalogClient(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 ServiceCatalogClient(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 ServiceCatalogClient(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 ServiceCatalogClient(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 ServiceCatalogClient(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 ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, 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 ServiceCatalogClient.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 ServiceCatalogClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
ServiceCatalog
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface ServiceCatalog
endpoint
- The endpoint of the service.public String getEndpoint()
ServiceCatalog
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface ServiceCatalog
public void setRegion(Region region)
ServiceCatalog
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.
setRegion
in interface ServiceCatalog
region
- The region of the service.public void setRegion(String regionId)
ServiceCatalog
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
.
setRegion
in interface ServiceCatalog
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public BulkReplaceServiceCatalogAssociationsResponse bulkReplaceServiceCatalogAssociations(BulkReplaceServiceCatalogAssociationsRequest request)
ServiceCatalog
Replace all associations of a given service catalog in one bulk transaction.
bulkReplaceServiceCatalogAssociations
in interface ServiceCatalog
request
- The request object containing the details to sendpublic ChangePrivateApplicationCompartmentResponse changePrivateApplicationCompartment(ChangePrivateApplicationCompartmentRequest request)
ServiceCatalog
Moves the specified private application from one compartment to another.
changePrivateApplicationCompartment
in interface ServiceCatalog
request
- The request object containing the details to sendpublic ChangeServiceCatalogCompartmentResponse changeServiceCatalogCompartment(ChangeServiceCatalogCompartmentRequest request)
ServiceCatalog
Moves the specified service catalog from one compartment to another.
changeServiceCatalogCompartment
in interface ServiceCatalog
request
- The request object containing the details to sendpublic CreatePrivateApplicationResponse createPrivateApplication(CreatePrivateApplicationRequest request)
ServiceCatalog
Creates a private application along with a single package to be hosted.
createPrivateApplication
in interface ServiceCatalog
request
- The request object containing the details to sendpublic CreateServiceCatalogResponse createServiceCatalog(CreateServiceCatalogRequest request)
ServiceCatalog
Creates a brand new service catalog in a given compartment.
createServiceCatalog
in interface ServiceCatalog
request
- The request object containing the details to sendpublic CreateServiceCatalogAssociationResponse createServiceCatalogAssociation(CreateServiceCatalogAssociationRequest request)
ServiceCatalog
Creates an association between service catalog and a resource.
createServiceCatalogAssociation
in interface ServiceCatalog
request
- The request object containing the details to sendpublic DeletePrivateApplicationResponse deletePrivateApplication(DeletePrivateApplicationRequest request)
ServiceCatalog
Deletes an existing private application.
deletePrivateApplication
in interface ServiceCatalog
request
- The request object containing the details to sendpublic DeleteServiceCatalogResponse deleteServiceCatalog(DeleteServiceCatalogRequest request)
ServiceCatalog
Deletes the specified service catalog from the compartment.
deleteServiceCatalog
in interface ServiceCatalog
request
- The request object containing the details to sendpublic DeleteServiceCatalogAssociationResponse deleteServiceCatalogAssociation(DeleteServiceCatalogAssociationRequest request)
ServiceCatalog
Removes an association between service catalog and a resource.
deleteServiceCatalogAssociation
in interface ServiceCatalog
request
- The request object containing the details to sendpublic GetPrivateApplicationResponse getPrivateApplication(GetPrivateApplicationRequest request)
ServiceCatalog
Gets the details of the specified private application.
getPrivateApplication
in interface ServiceCatalog
request
- The request object containing the details to sendpublic GetPrivateApplicationActionDownloadLogoResponse getPrivateApplicationActionDownloadLogo(GetPrivateApplicationActionDownloadLogoRequest request)
ServiceCatalog
Downloads the binary payload of the logo image of the private application.
getPrivateApplicationActionDownloadLogo
in interface ServiceCatalog
request
- The request object containing the details to sendpublic GetPrivateApplicationPackageResponse getPrivateApplicationPackage(GetPrivateApplicationPackageRequest request)
ServiceCatalog
Gets the details of a specific package within a given private application.
getPrivateApplicationPackage
in interface ServiceCatalog
request
- The request object containing the details to sendpublic GetPrivateApplicationPackageActionDownloadConfigResponse getPrivateApplicationPackageActionDownloadConfig(GetPrivateApplicationPackageActionDownloadConfigRequest request)
ServiceCatalog
Downloads the configuration that was used to create the private application package.
getPrivateApplicationPackageActionDownloadConfig
in interface ServiceCatalog
request
- The request object containing the details to sendpublic GetServiceCatalogResponse getServiceCatalog(GetServiceCatalogRequest request)
ServiceCatalog
Gets detailed information about the service catalog including name, compartmentId
getServiceCatalog
in interface ServiceCatalog
request
- The request object containing the details to sendpublic GetServiceCatalogAssociationResponse getServiceCatalogAssociation(GetServiceCatalogAssociationRequest request)
ServiceCatalog
Gets detailed information about specific service catalog association.
getServiceCatalogAssociation
in interface ServiceCatalog
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
ServiceCatalog
Gets the status of the work request with the given ID.
getWorkRequest
in interface ServiceCatalog
request
- The request object containing the details to sendpublic ListApplicationsResponse listApplications(ListApplicationsRequest request)
ServiceCatalog
Lists all the applications in a service catalog or a tenancy. If no parameter is specified, all catalogs from all compartments in the tenancy will be scanned for any type of content.
listApplications
in interface ServiceCatalog
request
- The request object containing the details to sendpublic ListPrivateApplicationPackagesResponse listPrivateApplicationPackages(ListPrivateApplicationPackagesRequest request)
ServiceCatalog
Lists the packages in the specified private application.
listPrivateApplicationPackages
in interface ServiceCatalog
request
- The request object containing the details to sendpublic ListPrivateApplicationsResponse listPrivateApplications(ListPrivateApplicationsRequest request)
ServiceCatalog
Lists all the private applications in a given compartment.
listPrivateApplications
in interface ServiceCatalog
request
- The request object containing the details to sendpublic ListServiceCatalogAssociationsResponse listServiceCatalogAssociations(ListServiceCatalogAssociationsRequest request)
ServiceCatalog
Lists all the resource associations for a specific service catalog.
listServiceCatalogAssociations
in interface ServiceCatalog
request
- The request object containing the details to sendpublic ListServiceCatalogsResponse listServiceCatalogs(ListServiceCatalogsRequest request)
ServiceCatalog
Lists all the service catalogs in the given compartment.
listServiceCatalogs
in interface ServiceCatalog
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
ServiceCatalog
Return a (paginated) list of errors for a given work request.
listWorkRequestErrors
in interface ServiceCatalog
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
ServiceCatalog
Return a (paginated) list of logs for a given work request.
listWorkRequestLogs
in interface ServiceCatalog
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
ServiceCatalog
Lists the work requests in a compartment.
listWorkRequests
in interface ServiceCatalog
request
- The request object containing the details to sendpublic UpdatePrivateApplicationResponse updatePrivateApplication(UpdatePrivateApplicationRequest request)
ServiceCatalog
Updates the details of an existing private application.
updatePrivateApplication
in interface ServiceCatalog
request
- The request object containing the details to sendpublic UpdateServiceCatalogResponse updateServiceCatalog(UpdateServiceCatalogRequest request)
ServiceCatalog
Updates the details of a previously created service catalog.
updateServiceCatalog
in interface ServiceCatalog
request
- The request object containing the details to sendpublic ServiceCatalogWaiters getWaiters()
ServiceCatalog
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface ServiceCatalog
public ServiceCatalogPaginators getPaginators()
ServiceCatalog
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 ServiceCatalog
Copyright © 2016–2022. All rights reserved.