commonMain.aws.sdk.kotlin.services.transfer.model.DescribeAccessRequest.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of transfer-jvm Show documentation
Show all versions of transfer-jvm Show documentation
The AWS SDK for Kotlin client for Transfer
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.transfer.model
import aws.smithy.kotlin.runtime.SdkDsl
public class DescribeAccessRequest private constructor(builder: Builder) {
/**
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
*
* `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid`
*
* In that command, replace *YourGroupName* with the name of your Active Directory group.
*
* The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
*/
public val externalId: kotlin.String? = builder.externalId
/**
* A system-assigned unique identifier for a server that has this access assigned.
*/
public val serverId: kotlin.String? = builder.serverId
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.transfer.model.DescribeAccessRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("DescribeAccessRequest(")
append("externalId=$externalId,")
append("serverId=$serverId")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = externalId?.hashCode() ?: 0
result = 31 * result + (serverId?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as DescribeAccessRequest
if (externalId != other.externalId) return false
if (serverId != other.serverId) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.transfer.model.DescribeAccessRequest = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
*
* `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid`
*
* In that command, replace *YourGroupName* with the name of your Active Directory group.
*
* The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
*/
public var externalId: kotlin.String? = null
/**
* A system-assigned unique identifier for a server that has this access assigned.
*/
public var serverId: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.transfer.model.DescribeAccessRequest) : this() {
this.externalId = x.externalId
this.serverId = x.serverId
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.transfer.model.DescribeAccessRequest = DescribeAccessRequest(this)
internal fun correctErrors(): Builder {
return this
}
}
}