Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JavaDownloadClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • JavaDownloadClient

Constructors

constructor

  • new JavaDownloadClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): JavaDownloadClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "JavaDownload"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://javamanagementservice-download.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

cancelWorkRequest

close

  • close(): void

createJavaDownloadReport

  • Create a new report in the specified format containing the download details for the tenancy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateJavaDownloadReport API.

    Parameters

    Returns Promise<CreateJavaDownloadReportResponse>

    CreateJavaDownloadReportResponse

createJavaDownloadToken

createJavaLicenseAcceptanceRecord

createWaiters

deleteJavaDownloadReport

deleteJavaDownloadToken

deleteJavaLicenseAcceptanceRecord

generateArtifactDownloadUrl

  • Generates a short-lived download URL and returns it in the response payload. The returned URL can then be used for downloading the specific Java runtime artifact.

    Use the {@link #getJavaRelease(GetJavaReleaseRequest) getJavaRelease} API to get information about available artifacts for a specific release. Each such artifact is uniquely identified by an `artifactId`. Refer {@link #javaArtifact(JavaArtifactRequest) javaArtifact} for more details.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GenerateArtifactDownloadUrl API.

    Parameters

    Returns Promise<GenerateArtifactDownloadUrlResponse>

    GenerateArtifactDownloadUrlResponse

getJavaDownloadReport

getJavaDownloadReportContent

getJavaDownloadToken

getJavaLicense

  • Return details of the specified Java license type.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetJavaLicense API.

    Parameters

    Returns Promise<GetJavaLicenseResponse>

    GetJavaLicenseResponse

getJavaLicenseAcceptanceRecord

getWaiters

getWorkRequest

  • Gets details of the work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listJavaDownloadRecords

  • Returns a list of Java download records in a tenancy based on specified parameters. See {@link #listJavaReleases(ListJavaReleasesRequest) listJavaReleases} for possible values of javaFamilyVersion and javaReleaseVersion parameters.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListJavaDownloadRecords API.

    Parameters

    Returns Promise<ListJavaDownloadRecordsResponse>

    ListJavaDownloadRecordsResponse

listJavaDownloadReports

listJavaDownloadTokens

listJavaLicenseAcceptanceRecords

listJavaLicenses

listWorkRequestErrors

listWorkRequestLogs

  • Returns a (paginated) list of logs for the work request with the given ID.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

requestSummarizedJavaDownloadCounts

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateJavaDownloadToken

updateJavaLicenseAcceptanceRecord