org.everit.atlassian.restclient.jiracloud.v2.api

Class AttachmentApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.AttachmentApi

public class AttachmentApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AttachmentApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<AttachmentArchiveMetadataReadable>	expandAttachmentForHumans(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all metadata for an expanded attachment Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself.
io.reactivex.Single<AttachmentArchiveImpl>	expandAttachmentForMachines(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get contents metadata for an expanded attachment Returns the metadata for the contents of an attachment, if it is an archive.
io.reactivex.Single<AttachmentMetadata>	getAttachment(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get attachment metadata Returns the metadata for an attachment.
io.reactivex.Single<AttachmentSettings>	getAttachmentMeta(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get Jira attachment settings Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.
io.reactivex.Completable	removeAttachment(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete attachment Deletes an attachment from an issue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttachmentApi

public AttachmentApi(org.everit.http.restclient.RestClient restClient)

Method Detail

expandAttachmentForHumans

public io.reactivex.Single<AttachmentArchiveMetadataReadable> expandAttachmentForHumans(String id,
                                                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all metadata for an expanded attachment

Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive. Currently, only the ZIP archive format is supported.

Use this operation to retrieve data that is presented to the user, as this operation returns the metadata for the attachment itself, such as the attachment's ID and name. Otherwise, use Get contents metadata for an expanded attachment, which only returns the metadata for the attachment's contents.

This operation can be accessed anonymously.

Permissions required: For the issue containing the attachment:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Parameters:

id -

The ID of the attachment.

(required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<AttachmentArchiveMetadataReadable>

expandAttachmentForMachines

public io.reactivex.Single<AttachmentArchiveImpl> expandAttachmentForMachines(String id,
                                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get contents metadata for an expanded attachment

Returns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported.

Use this operation if you are processing the data without presenting it to the user, as this operation only returns the metadata for the contents of the attachment. Otherwise, to retrieve data to present to the user, use Get all metadata for an expanded attachment which also returns the metadata for the attachment itself, such as the attachment's ID and name.

This operation can be accessed anonymously.

Permissions required: For the issue containing the attachment:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Parameters:

id -

The ID of the attachment.

(required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<AttachmentArchiveImpl>

getAttachment

public io.reactivex.Single<AttachmentMetadata> getAttachment(String id,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get attachment metadata

Returns the metadata for an attachment. Note that the attachment itself is not returned.

This operation can be accessed anonymously.

Permissions required:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Parameters:

id -

The ID of the attachment.

(required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<AttachmentMetadata>

getAttachmentMeta

public io.reactivex.Single<AttachmentSettings> getAttachmentMeta(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get Jira attachment settings

Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.

Note that there are also project permissions that restrict whether users can create and delete attachments.

This operation can be accessed anonymously.

Permissions required: None.

Parameters:

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<AttachmentSettings>

removeAttachment

public io.reactivex.Completable removeAttachment(String id,
                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete attachment

Deletes an attachment from an issue.

This operation can be accessed anonymously.

Permissions required: For the project holding the issue containing the attachment:

• Delete own attachments project permission to delete an attachment created by the calling user.
• Delete all attachments project permission to delete an attachment created by any user.

Parameters:

id -

The ID of the attachment.

(required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable