Class ApiGatewayClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.apigateway.ApiGatewayClient
-
- All Implemented Interfaces:
ApiGateway
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20190501") public class ApiGatewayClient extends BaseSyncClient implements ApiGateway
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ApiGatewayClient.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 ApiGateway.
-
Constructor Summary
Constructors Constructor Description ApiGatewayClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.ApiGatewayClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.ApiGatewayClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ApiGatewayClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ApiGatewayClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.ApiGatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.ApiGatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.ApiGatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ApiGatewayClient.Builder
builder()
Create a builder for this client.ChangeApiCompartmentResponse
changeApiCompartment(ChangeApiCompartmentRequest request)
Changes the API compartment.ChangeCertificateCompartmentResponse
changeCertificateCompartment(ChangeCertificateCompartmentRequest request)
Changes the certificate compartment.void
close()
CreateApiResponse
createApi(CreateApiRequest request)
Creates a new API.CreateCertificateResponse
createCertificate(CreateCertificateRequest request)
Creates a new Certificate.CreateSdkResponse
createSdk(CreateSdkRequest request)
Creates a new SDK.DeleteApiResponse
deleteApi(DeleteApiRequest request)
Deletes the API with the given identifier.DeleteCertificateResponse
deleteCertificate(DeleteCertificateRequest request)
Deletes the certificate with the given identifier.DeleteSdkResponse
deleteSdk(DeleteSdkRequest request)
Deletes provided SDK.GetApiResponse
getApi(GetApiRequest request)
Gets an API by identifier.GetApiContentResponse
getApiContent(GetApiContentRequest request)
Get the raw API content.GetApiDeploymentSpecificationResponse
getApiDeploymentSpecification(GetApiDeploymentSpecificationRequest request)
Gets an API Deployment specification by identifier.GetApiValidationsResponse
getApiValidations(GetApiValidationsRequest request)
Gets the API validation results.GetCertificateResponse
getCertificate(GetCertificateRequest request)
Gets a certificate by identifier.String
getClientCommonLibraryVersion()
protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
ApiGatewayPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetSdkResponse
getSdk(GetSdkRequest request)
Return object store downloadable URL and metadata.ApiGatewayWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.ListApisResponse
listApis(ListApisRequest request)
Returns a list of APIs.ListCertificatesResponse
listCertificates(ListCertificatesRequest request)
Returns a list of certificates.ListSdkLanguageTypesResponse
listSdkLanguageTypes(ListSdkLanguageTypesRequest request)
Lists programming languages in which SDK can be generated.ListSdksResponse
listSdks(ListSdksRequest request)
Returns list of generated SDKs.void
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.void
refreshClient()
Rebuild the backingHttpClient
.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’).UpdateApiResponse
updateApi(UpdateApiRequest request)
Updates the API with the given identifier.void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.UpdateCertificateResponse
updateCertificate(UpdateCertificateRequest request)
Updates a certificate with the given identifierUpdateSdkResponse
updateSdk(UpdateSdkRequest request)
Updates the SDK with the given identifier.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 com.oracle.bmc.apigateway.ApiGateway
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Constructor Detail
-
ApiGatewayClient
@Deprecated public ApiGatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeApiGatewayClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
ApiGatewayClient
@Deprecated public ApiGatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeApiGatewayClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
ApiGatewayClient
@Deprecated public ApiGatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeApiGatewayClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ApiGatewayClient
@Deprecated public ApiGatewayClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeApiGatewayClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
ApiGatewayClient
@Deprecated public ApiGatewayClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeApiGatewayClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
ApiGatewayClient
@Deprecated public ApiGatewayClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeApiGatewayClient.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)
-
ApiGatewayClient
@Deprecated public ApiGatewayClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeApiGatewayClient.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
-
ApiGatewayClient
@Deprecated public ApiGatewayClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeApiGatewayClient.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
-ApiGatewayClient.Builder.executorService
-
-
Method Detail
-
builder
public static ApiGatewayClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:ApiGateway
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 interfaceApiGateway
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ApiGateway
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 callsetEndpoint
.- Specified by:
setRegion
in interfaceApiGateway
- Parameters:
regionId
- The public region ID.
-
changeApiCompartment
public ChangeApiCompartmentResponse changeApiCompartment(ChangeApiCompartmentRequest request)
Description copied from interface:ApiGateway
Changes the API compartment.- Specified by:
changeApiCompartment
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeCertificateCompartment
public ChangeCertificateCompartmentResponse changeCertificateCompartment(ChangeCertificateCompartmentRequest request)
Description copied from interface:ApiGateway
Changes the certificate compartment.- Specified by:
changeCertificateCompartment
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createApi
public CreateApiResponse createApi(CreateApiRequest request)
Description copied from interface:ApiGateway
Creates a new API.- Specified by:
createApi
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createCertificate
public CreateCertificateResponse createCertificate(CreateCertificateRequest request)
Description copied from interface:ApiGateway
Creates a new Certificate.- Specified by:
createCertificate
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSdk
public CreateSdkResponse createSdk(CreateSdkRequest request)
Description copied from interface:ApiGateway
Creates a new SDK.- Specified by:
createSdk
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteApi
public DeleteApiResponse deleteApi(DeleteApiRequest request)
Description copied from interface:ApiGateway
Deletes the API with the given identifier.- Specified by:
deleteApi
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteCertificate
public DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest request)
Description copied from interface:ApiGateway
Deletes the certificate with the given identifier.- Specified by:
deleteCertificate
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSdk
public DeleteSdkResponse deleteSdk(DeleteSdkRequest request)
Description copied from interface:ApiGateway
Deletes provided SDK.- Specified by:
deleteSdk
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getApi
public GetApiResponse getApi(GetApiRequest request)
Description copied from interface:ApiGateway
Gets an API by identifier.- Specified by:
getApi
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getApiContent
public GetApiContentResponse getApiContent(GetApiContentRequest request)
Description copied from interface:ApiGateway
Get the raw API content.- Specified by:
getApiContent
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getApiDeploymentSpecification
public GetApiDeploymentSpecificationResponse getApiDeploymentSpecification(GetApiDeploymentSpecificationRequest request)
Description copied from interface:ApiGateway
Gets an API Deployment specification by identifier.- Specified by:
getApiDeploymentSpecification
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getApiValidations
public GetApiValidationsResponse getApiValidations(GetApiValidationsRequest request)
Description copied from interface:ApiGateway
Gets the API validation results.- Specified by:
getApiValidations
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCertificate
public GetCertificateResponse getCertificate(GetCertificateRequest request)
Description copied from interface:ApiGateway
Gets a certificate by identifier.- Specified by:
getCertificate
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSdk
public GetSdkResponse getSdk(GetSdkRequest request)
Description copied from interface:ApiGateway
Return object store downloadable URL and metadata.- Specified by:
getSdk
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listApis
public ListApisResponse listApis(ListApisRequest request)
Description copied from interface:ApiGateway
Returns a list of APIs.- Specified by:
listApis
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCertificates
public ListCertificatesResponse listCertificates(ListCertificatesRequest request)
Description copied from interface:ApiGateway
Returns a list of certificates.- Specified by:
listCertificates
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSdkLanguageTypes
public ListSdkLanguageTypesResponse listSdkLanguageTypes(ListSdkLanguageTypesRequest request)
Description copied from interface:ApiGateway
Lists programming languages in which SDK can be generated.- Specified by:
listSdkLanguageTypes
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSdks
public ListSdksResponse listSdks(ListSdksRequest request)
Description copied from interface:ApiGateway
Returns list of generated SDKs.- Specified by:
listSdks
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateApi
public UpdateApiResponse updateApi(UpdateApiRequest request)
Description copied from interface:ApiGateway
Updates the API with the given identifier.- Specified by:
updateApi
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateCertificate
public UpdateCertificateResponse updateCertificate(UpdateCertificateRequest request)
Description copied from interface:ApiGateway
Updates a certificate with the given identifier- Specified by:
updateCertificate
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSdk
public UpdateSdkResponse updateSdk(UpdateSdkRequest request)
Description copied from interface:ApiGateway
Updates the SDK with the given identifier.- Specified by:
updateSdk
in interfaceApiGateway
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public ApiGatewayWaiters getWaiters()
Description copied from interface:ApiGateway
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceApiGateway
- Returns:
- The service waiters.
-
getPaginators
public ApiGatewayPaginators getPaginators()
Description copied from interface:ApiGateway
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 interfaceApiGateway
- 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 userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-