Class CreateMicrosoftTeamsChannelConfigurationRequest
java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.chatbot.model.ChatbotRequest
software.amazon.awssdk.services.chatbot.model.CreateMicrosoftTeamsChannelConfigurationRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateMicrosoftTeamsChannelConfigurationRequest.Builder,
CreateMicrosoftTeamsChannelConfigurationRequest>
@Generated("software.amazon.awssdk:codegen")
public final class CreateMicrosoftTeamsChannelConfigurationRequest
extends ChatbotRequest
implements ToCopyableBuilder<CreateMicrosoftTeamsChannelConfigurationRequest.Builder,CreateMicrosoftTeamsChannelConfigurationRequest>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The ID of the Microsoft Teams channel.final String
The name of the Microsoft Teams channel.final String
The name of the configuration.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.The list of IAM policy ARNs that are applied as channel guardrails.final boolean
For responses, this returns true if the service returned a value for the GuardrailPolicyArns property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SnsTopicArns property.final String
The ARN of the IAM role that defines the permissions for AWS Chatbot.final String
Logging levels include ERROR, INFO, or NONE.static Class
<? extends CreateMicrosoftTeamsChannelConfigurationRequest.Builder> The ARNs of the SNS topics that deliver notifications to AWS Chatbot.final String
teamId()
The ID of the Microsoft Team authorized with AWS Chatbot.final String
teamName()
The name of the Microsoft Teams Team.final String
tenantId()
The ID of the Microsoft Teams tenant.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
Enables use of a user role requirement in your chat configuration.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
channelId
The ID of the Microsoft Teams channel.- Returns:
- The ID of the Microsoft Teams channel.
-
channelName
The name of the Microsoft Teams channel.- Returns:
- The name of the Microsoft Teams channel.
-
teamId
The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.- Returns:
- The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
-
teamName
The name of the Microsoft Teams Team.- Returns:
- The name of the Microsoft Teams Team.
-
tenantId
The ID of the Microsoft Teams tenant.- Returns:
- The ID of the Microsoft Teams tenant.
-
hasSnsTopicArns
public final boolean hasSnsTopicArns()For responses, this returns true if the service returned a value for the SnsTopicArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
snsTopicArns
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSnsTopicArns()
method.- Returns:
- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
-
iamRoleArn
The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.- Returns:
- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
-
configurationName
The name of the configuration.- Returns:
- The name of the configuration.
-
loggingLevel
Logging levels include ERROR, INFO, or NONE.- Returns:
- Logging levels include ERROR, INFO, or NONE.
-
hasGuardrailPolicyArns
public final boolean hasGuardrailPolicyArns()For responses, this returns true if the service returned a value for the GuardrailPolicyArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
guardrailPolicyArns
The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasGuardrailPolicyArns()
method.- Returns:
- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
-
userAuthorizationRequired
Enables use of a user role requirement in your chat configuration.- Returns:
- Enables use of a user role requirement in your chat configuration.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateMicrosoftTeamsChannelConfigurationRequest.Builder,
CreateMicrosoftTeamsChannelConfigurationRequest> - Specified by:
toBuilder
in classChatbotRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateMicrosoftTeamsChannelConfigurationRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-