Versions Compared

Old Version 1

changes.mady.by.user Kirstin Seidel-Gebert

Saved on

compared with

New Version 2

changes.mady.by.user Kirstin Seidel-Gebert

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Mittels Scroll Versions veröffentlicht aus dem Bereich WDESIGNER und Version 23.1a.

Stereotype Attributes

S3 Alias

Multiexcerpt
MultiExcerptNameS3_Alias
shouldDisplayInlineCommentsInIncludesfalse
AttributeDescriptionAllowed Values / Examples
endpointOverrideSpecify hostname and port (if necessary) of the S3 endpoint. minio:9000
scheme
Specify the protocol to access the S3 endpoint specified with endpointOverride.httpUse the HTTP protocol.
httpsUse the HTTPS protocol (default).
regionSpecify the Amazon region your S3 is hosted in (if necessary).
followRedirectsPolicy
Specify the redirect behavior of requests to the S3 endpoint.DEFAULT
ALWAYS		Always redirect.
NEVERNever redirect.
disableExpectHeader
Specify whether the "Expect: 100-Continue" should not be added your request to the S3 endpoint.trueDo not add an "Expect: 100-Continue" header to the request.
falseAdd an "Expect: 100-Continue" header to the request.
Authentication
user
Specify the user that will be used to access the S3 endpoint. aMinioUser
password
Specify the password of user. aMinioPassword
SSL / TLS
certificateAuthorityPathSpecify the path to your certificate trust store.

certificateAuthorityFilePath
Specify the path to the certificate authority.

verifySSL
Specify whether to disable SSL checks. This is for testing purposes only and should not disabled in productive environments.truePerform SSL checks.
falseDisable SSL checks.
Proxy
proxyHost
Specify the URL of the proxy server.See CURLOPT_PROXY.
proxyPort
Specify the proxy port.See CURLOPT_PROXY.
proxyScheme
Specify the proxy protocol.See CURLOPT_PROXY.
httpUse the HTTP protocol.
httpsUse the HTTPS protocol (default).
Proxy Authentication
proxyUser
Specify the proxy user.See CURLOPT_PROXYUSERPWD.
proxyPassword
Specify the proxy password.See CURLOPT_PROXYUSERPWD.
Proxy SSL / TLS
proxyCertificateFile
Specify a file name containing the proxy certificate.
proxyCertificateType
Specify the type of the certificate.
proxySSLKeyFile
Specify a file name containing the private key.
proxySSLKeyType
Specify the type of the key.
proxySSLKeyPassword
Specify the password for the private key.

Parameters Bucket Handling

bucketStatus

If the bucket you want to get the status of is not existing, an exception is thrown.

Multiexcerpt
MultiExcerptNamebucketStatus
shouldDisplayInlineCommentsInIncludesfalse
NameTypeDirectionDescriptionAllowed Values / Examples
bucketNameStringinName of the bucket to get the status of.
bucketStatusBucketStatusoutObject containing the status information as described further below.

createBucket

Multiexcerpt
MultiExcerptNamecreateBucket
shouldDisplayInlineCommentsInIncludesfalse
NameTypeDirectionDescriptionAllowed Values / Examples
bucketNameStringin

Name of the bucket to create.

Info

The name of the bucket should be prefixed with the PAS client.

If a bucket with the same name is already existing or if the bucket name does not match the S3 bucket naming rules, an exception is thrown.

pas-doc-examples

deleteBucket

Multiexcerpt
MultiExcerptNamedeleteBucket
shouldDisplayInlineCommentsInIncludesfalse
NameTypeDirectionDescriptionAllowed Values / Examples
bucketNameStringinName of the bucket to delete.There will be no exception if the bucket you want to delete is not existing.
deleteRecursively
Booleanin

With S3, as a rule, only empty buckets can be deleted. Specify here whether to delete the bucket and all of its contents in one go.

trueDelete the bucket and all its contents.
falseBucket must be empty to be deleted (default).

listBuckets

Multiexcerpt
MultiExcerptNamelistBuckets
shouldDisplayInlineCommentsInIncludesfalse
NameTypeDirectionDescriptionAllowed Values / Examples
bucketNamesArray of StringoutList of buckets that are available from the specified S3 endpoint.

listObjects

Multiexcerpt
MultiExcerptNamelistObjects
shouldDisplayInlineCommentsInIncludesfalse
NameTypeDirectionDescriptionAllowed Values / Examples
bucketNameStringinName of the bucket to list the contents of.If the bucket is not existing, an exception is thrown.
objectNamesArray of StringoutList of objects that reside within the given bucket.

Operations and Parameters Object Handling

copyObject

Multiexcerpt
MultiExcerptNamecopyObject
shouldDisplayInlineCommentsInIncludesfalse
NameTypeDirectionDescriptionAllowed Values / Examples
bucketNameStringinName of the bucket to copy an object from.If the bucket is not existing, an exception is thrown.
objectNameStringinName of the object to be copied.If the object is not existing, an exception is thrown.
targetBucketNameStringin

Name of the bucket to copy the selected object to.

If the bucket is not existing, an exception is thrown. Also, the target bucket must differ from the source bucket.

deleteObject Operations

  • delete ( bucketName : String, objectName : String )
  • delete ( bucketName : String, objectName : String, version : String )
Multiexcerpt
MultiExcerptNamedeleteObject
shouldDisplayInlineCommentsInIncludesfalse
NameTypeDirectionDescriptionAllowed Values / Examples
bucketNameStringinName of the bucket to delete an object from.If the bucket is not existing, an exception is thrown.
objectNameStringinName of the object to delete.If the object is not existing, no exception will be thrown.
versionStringin

For versioned buckets: Specify here the identifier of the object version to delete. If no version is specified for a versioned bucket, a new delete marker is created and the object is marked as deleted (see deleteMarkers).

If the version is not existing, an exception is thrown.

getObject Operations

  • getObject ( bucketName : String, objectName : String, filePath : String )
  • getObject ( bucketName : String, objectName : String, filePath : String, version : String )
  • getObject ( bucketName : String, objectName : String, objectData: Blob )
  • getObject ( bucketName : String, objectName : String, version : String, objectData: Blob )
Multiexcerpt
MultiExcerptNamegetObject
shouldDisplayInlineCommentsInIncludesfalse
NameTypeDirectionDescriptionAllowed Values / Examples
bucketNameStringinName of the bucket to get an object from.If the bucket is not existing, an exception is thrown.
objectNameStringinName of the object to get.If the object is not existing, an exception is thrown.
versionStringinVersion of the object to get. If no version is specified, the latest version is retrieved.If the version is not existing, an exception is thrown.
filePathStringinPath of the file on the local filesystem (in service context) to store the retrieved object to.If the file path cannot be accessed, an exception is thrown.
objectDataBloboutBlob containing the contents of the retrieved object data.

listObjects

Multiexcerpt include
MultiExcerptNamelistObjects
PageWithExcerptS3
shouldDisplayInlineCommentsInIncludesfalse

objectStatus

Multiexcerpt
MultiExcerptNameobjectStatus
NameTypeDirectionDescriptionAllowed Values / Examples
bucketNameStringinName of the bucket the object resides in.If the bucket is not existing, an exception is thrown.
objectNameStringinName of the object to get the object status of.If the object is not existing, an exception is thrown.
objectStatusObjectStatusoutObject containing the status information as described further below.

putObject

If the bucket is not versioned, the object is updated without any further warning, otherwise a new version of the object is created.

  • putObject ( bucketName : String, objectName : String, filePath : String )
  • putObject ( bucketName : String, objectName : String, objectData: Blob )
Multiexcerpt
MultiExcerptNameputObject
NameTypeDirectionDescriptionAllowed Values / Examples
bucketNameStringinName of the bucket to put the object to. This must be an existing bucket, otherwise an exception is thrown.If the bucket is not existing, an exception is thrown.
objectNameStringinName of the object to store.No exception will be thrown if the object you want to put is already existing.
filePathStringinPath to the file on the local filesystem (in service context) to get the object contents from.You must specify either filePath, or objectData.
If the file is not available, an exception will be thrown.
objectDataBlobinObject data to store as a Blob.You must specify either objectData, or filePath.

S3 Adapter Parameter Types

BucketStatus

Multiexcerpt
MultiExcerptNameBucketStatus
shouldDisplayInlineCommentsInIncludesfalse
AttributeTypeDescription
nameStringName of the bucket.
sizeIntegerSize of the bucket in bytes.
containedObjectsArray of StringList of objects that reside within the bucket.
creationDate
DateTimeCreation timestamp of the bucket.

ObjectStatus

Multiexcerpt
MultiExcerptNameObjectStatus
shouldDisplayInlineCommentsInIncludesfalse
AttributeTypeDescriptionExamples
nameStringName of the object.
sizeIntegerSize of the object in bytes.
type
StringType of the object as identified by AWS. png, txt
creationDate
DateTimeCreation timestamp of the object (last version if versioned).
latestVersion
StringNumber of the latest version.
versions
Array of StringList of version numbers of the object.
The order within the array reflects the order in which the versions have been created. So, versions[0] contains the version number of the first version of the object.
deleteMarkers
Array of StringList of delete markers of the object.

Otp
Floatingfalse

Rp

Children Display
pageS3 Adapter