JavaDownloadClient¶

class oci.jms_java_downloads.JavaDownloadClient(config, **kwargs)¶

The APIs for the download engine of the Java Management Service.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`cancel_work_request`(work_request_id, **kwargs)	Cancels the work request with the given ID.
`create_java_download_report`(…)	Create a new report in the specified format containing the download details for the tenancy.
`create_java_download_token`(…)	Creates a new JavaDownloadToken in the tenancy with specified attributes.
`create_java_license_acceptance_record`(…)	Creates a Java license acceptance record for the specified license type in a tenancy.
`delete_java_download_report`(…)	Deletes a JavaDownloadReport resource by identifier.
`delete_java_download_token`(…)	Deletes a JavaDownloadToken resource by identifier.
`delete_java_license_acceptance_record`(…)	Deletes a Java license acceptance record with the specified identifier.
`generate_artifact_download_url`(…)	Generates a short-lived download URL and returns it in the response payload.
`get_java_download_report`(…)	Gets a JavaDownloadReport by the specified identifier.
`get_java_download_report_content`(…)	Retrieve a Java download report with the specified identifier.
`get_java_download_token`(…)	Gets a JavaDownloadToken by identifier
`get_java_license`(license_type, **kwargs)	Return details of the specified Java license type.
`get_java_license_acceptance_record`(…)	Returns a specific Java license acceptance record in a tenancy.
`get_work_request`(work_request_id, **kwargs)	Gets details of the work request with the given ID.
`list_java_download_records`(compartment_id, …)	Returns a list of Java download records in a tenancy based on specified parameters.
`list_java_download_reports`(compartment_id, …)	Returns a list of JavaDownloadReports.
`list_java_download_tokens`(compartment_id, …)	Returns a list of JavaDownloadTokens.
`list_java_license_acceptance_records`(…)	Returns a list of all the Java license acceptance records in a tenancy.
`list_java_licenses`(**kwargs)	Return a list with details of all Java licenses.
`list_work_request_errors`(work_request_id, …)	Returns a (paginated) list of errors for the work request with the given ID.
`list_work_request_logs`(work_request_id, **kwargs)	Returns a (paginated) list of logs for the work request with the given ID.
`list_work_requests`(compartment_id, **kwargs)	Lists the work requests in a tenancy.
`request_summarized_java_download_counts`(…)	Returns list of download counts grouped by the specified property.
`update_java_download_token`(…)	Updates the JavaDownloadToken specified by the identifier.
`update_java_license_acceptance_record`(…)	Updates a specific Java license acceptance record in a tenancy.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

cancel_work_request(work_request_id, **kwargs)¶

Cancels the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the ETag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the ETag you provide matches the resource’s current ETag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use cancel_work_request API.

create_java_download_report(create_java_download_report_details, **kwargs)¶

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

Parameters:	create_java_download_report_details (oci.jms_java_downloads.models.CreateJavaDownloadReportDetails) – (required) Details for the new report. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use create_java_download_report API.

create_java_download_token(create_java_download_token_details, **kwargs)¶

Creates a new JavaDownloadToken in the tenancy with specified attributes.

Parameters:	create_java_download_token_details (oci.jms_java_downloads.models.CreateJavaDownloadTokenDetails) – (required) Details for the new JavaDownloadToken. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaDownloadToken`
Return type:	`Response`
Example:

Click here to see an example of how to use create_java_download_token API.

create_java_license_acceptance_record(create_java_license_acceptance_record_details, **kwargs)¶

Creates a Java license acceptance record for the specified license type in a tenancy.

Parameters:	create_java_license_acceptance_record_details (oci.jms_java_downloads.models.CreateJavaLicenseAcceptanceRecordDetails) – (required) Details for the new JavaLicenseAcceptanceRecord. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaLicenseAcceptanceRecord`
Return type:	`Response`
Example:

Click here to see an example of how to use create_java_license_acceptance_record API.

delete_java_download_report(java_download_report_id, **kwargs)¶

Deletes a JavaDownloadReport resource by identifier.

Parameters:	java_download_report_id (str) – (required) Unique Java download report identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the ETag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the ETag you provide matches the resource’s current ETag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_java_download_report API.

delete_java_download_token(java_download_token_id, **kwargs)¶

Deletes a JavaDownloadToken resource by identifier.

Parameters:	java_download_token_id (str) – (required) Unique JavaDownloadToken identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the ETag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the ETag you provide matches the resource’s current ETag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_java_download_token API.

delete_java_license_acceptance_record(java_license_acceptance_record_id, **kwargs)¶

Deletes a Java license acceptance record with the specified identifier.

Parameters:	java_license_acceptance_record_id (str) – (required) Unique Java license acceptance record identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the ETag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the ETag you provide matches the resource’s current ETag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_java_license_acceptance_record API.

generate_artifact_download_url(generate_artifact_download_url_details, **kwargs)¶

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 get_java_release() API to get information about available artifacts for a specific release. Each such artifact is uniquely identified by an artifactId. Refer java_artifact() for more details.

Parameters:	generate_artifact_download_url_details (oci.jms_java_downloads.models.GenerateArtifactDownloadUrlDetails) – (required) Details for generating download URL for a Java artifact. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DownloadUrl`
Return type:	`Response`
Example:

Click here to see an example of how to use generate_artifact_download_url API.

get_java_download_report(java_download_report_id, **kwargs)¶

Gets a JavaDownloadReport by the specified identifier.

Parameters:	java_download_report_id (str) – (required) Unique Java download report identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaDownloadReport`
Return type:	`Response`
Example:

Click here to see an example of how to use get_java_download_report API.

get_java_download_report_content(java_download_report_id, **kwargs)¶

Retrieve a Java download report with the specified identifier.

Parameters:	java_download_report_id (str) – (required) Unique Java download report identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type stream
Return type:	`Response`
Example:

Click here to see an example of how to use get_java_download_report_content API.

get_java_download_token(java_download_token_id, **kwargs)¶

Gets a JavaDownloadToken by identifier

Parameters:	java_download_token_id (str) – (required) Unique JavaDownloadToken identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaDownloadToken`
Return type:	`Response`
Example:

Click here to see an example of how to use get_java_download_token API.

get_java_license(license_type, **kwargs)¶

Return details of the specified Java license type.

Parameters:	license_type (str) – (required) Unique Java license type. Allowed values are: “OTN”, “NFTC”, “RESTRICTED” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaLicense`
Return type:	`Response`
Example:

Click here to see an example of how to use get_java_license API.

get_java_license_acceptance_record(java_license_acceptance_record_id, **kwargs)¶

Returns a specific Java license acceptance record in a tenancy.

Parameters:	java_license_acceptance_record_id (str) – (required) Unique Java license acceptance record identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaLicenseAcceptanceRecord`
Return type:	`Response`
Example:

Click here to see an example of how to use get_java_license_acceptance_record API.

get_work_request(work_request_id, **kwargs)¶

Gets details of the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use get_work_request API.

list_java_download_records(compartment_id, **kwargs)¶

Returns a list of Java download records in a tenancy based on specified parameters. See list_java_releases() for possible values of javaFamilyVersion and javaReleaseVersion parameters.

Parameters:	compartment_id (str) – (required) The OCID of the tenancy. family_version (str) – (optional) Unique Java family version identifier. release_version (str) – (optional) Unique Java release version identifier. os_family (str) – (optional) Target Operating System family of the artifact. architecture (str) – (optional) Target Operating System architecture of the artifact. package_type_detail (str) – (optional) Packaging type detail of the artifact. time_start (datetime) – (optional) The start of the time period for which reports are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period for which reports are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) If no value is specified _timeDownloaded_ is default. Allowed values are: “timeDownloaded”, “downloadSourceId”, “downloadType” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaDownloadRecordCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_java_download_records API.

list_java_download_reports(compartment_id, **kwargs)¶

Returns a list of JavaDownloadReports.

Parameters:	compartment_id (str) – (required) The OCID of the tenancy. lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the given lifecycleState. Allowed values are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “NEEDS_ATTENTION”, “UPDATING” display_name (str) – (optional) A filter to return only resources that match the display name. java_download_report_id (str) – (optional) Unique Java download report identifier. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. If no value is specified, _timeCreated_ is the default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaDownloadReportCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_java_download_reports API.

list_java_download_tokens(compartment_id, **kwargs)¶

Returns a list of JavaDownloadTokens.

Parameters:	compartment_id (str) – (required) The OCID of the tenancy. lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the given lifecycleState. Allowed values are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “NEEDS_ATTENTION”, “UPDATING” display_name (str) – (optional) A filter to return only resources that match the entire display name given. id (str) – (optional) Unique JavaDownloadToken identifier. value (str) – (optional) Unique JavaDownloadToken value. family_version (str) – (optional) Unique Java family version identifier. search_by_user (str) – (optional) A filter to return only resources that match the user principal detail. The search string can be any of the property values from the `principal()` object. This object is used as response datatype for the createdBy and lastUpdatedBy fields in applicable resource. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. If no value is specified, _timeCreated_ is the default. Allowed values are: “timeCreated”, “timeExpires”, “state”, “displayName”, “javaVersion” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaDownloadTokenCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_java_download_tokens API.

list_java_license_acceptance_records(compartment_id, **kwargs)¶

Returns a list of all the Java license acceptance records in a tenancy.

Parameters:	compartment_id (str) – (required) The OCID of the tenancy. search_by_user (str) – (optional) A filter to return only resources that match the user principal detail. The search string can be any of the property values from the `principal()` object. This object is used as response datatype for the createdBy and lastUpdatedBy fields in applicable resource. id (str) – (optional) Unique Java license acceptance record identifier. license_type (str) – (optional) Unique Java license type. Allowed values are: “OTN”, “NFTC”, “RESTRICTED” status (str) – (optional) The status of license acceptance. Allowed values are: “ACCEPTED”, “REVOKED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. If no value is specified, _timeAccepted_ is the default. Allowed values are: “timeAccepted”, “timeLastUpdated”, “licenseAcceptanceStatus” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaLicenseAcceptanceRecordCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_java_license_acceptance_records API.

list_java_licenses(**kwargs)¶

Return a list with details of all Java licenses.

Parameters:	license_type (str) – (optional) Unique Java license type. Allowed values are: “OTN”, “NFTC”, “RESTRICTED” display_name (str) – (optional) A filter to return only resources that match the display name. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. If no value is specified, _licenseType_ is the default. Allowed values are: “licenseType”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaLicenseCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_java_licenses API.

list_work_request_errors(work_request_id, **kwargs)¶

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

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. Allowed values are: “timestamp” sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestErrorCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)¶

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

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. Allowed values are: “timestamp” sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestLogEntryCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(compartment_id, **kwargs)¶

Lists the work requests in a tenancy.

Parameters:	compartment_id (str) – (required) The OCID of the tenancy. id (str) – (optional) The ID of an asynchronous work request. status (str) – (optional) A filter to return only resources their lifecycleState matches the given OperationStatus. Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “NEEDS_ATTENTION”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED” resource_id (str) – (optional) The ID of the resource affected by the work request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: “timeAccepted” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestSummaryCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_requests API.

request_summarized_java_download_counts(request_summarized_java_download_counts_details, **kwargs)¶

Returns list of download counts grouped by the specified property.

Parameters:	request_summarized_java_download_counts_details (oci.jms_java_downloads.models.RequestSummarizedJavaDownloadCountsDetails) – (required) Details for retreiving the summary of download counts. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaDownloadCountAggregationCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use request_summarized_java_download_counts API.

update_java_download_token(java_download_token_id, update_java_download_token_details, **kwargs)¶

Updates the JavaDownloadToken specified by the identifier.

Parameters:	java_download_token_id (str) – (required) Unique JavaDownloadToken identifier. update_java_download_token_details (oci.jms_java_downloads.models.UpdateJavaDownloadTokenDetails) – (required) The attributes to be updated. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the ETag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the ETag you provide matches the resource’s current ETag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_java_download_token API.

update_java_license_acceptance_record(java_license_acceptance_record_id, update_java_license_acceptance_record_details, **kwargs)¶

Updates a specific Java license acceptance record in a tenancy.

Parameters:	java_license_acceptance_record_id (str) – (required) Unique Java license acceptance record identifier. update_java_license_acceptance_record_details (oci.jms_java_downloads.models.UpdateJavaLicenseAcceptanceRecordDetails) – (required) Attributes for updating the JavaLicenseAcceptanceRecord. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the ETag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the ETag you provide matches the resource’s current ETag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JavaLicenseAcceptanceRecord`
Return type:	`Response`
Example:

Click here to see an example of how to use update_java_license_acceptance_record API.