Package software.amazon.awssdk.services.cloudwatchlogs.model

Class PutDestinationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.PutDestinationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutDestinationRequest.Builder,PutDestinationRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutDestinationRequest
extends CloudWatchLogsRequest
implements ToCopyableBuilder<PutDestinationRequest.Builder,PutDestinationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutDestinationRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutDestinationRequest.Builder	builder()
String	destinationName()	A name for the destination.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	roleArn()	The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.
List<SdkField<?>>	sdkFields()
static Class<? extends PutDestinationRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	An optional list of key-value pairs to associate with the resource.
String	targetArn()	The ARN of an Amazon Kinesis stream to which to deliver matching log events.
PutDestinationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

destinationName

public final String destinationName()

A name for the destination.

Returns:

A name for the destination.

targetArn

public final String targetArn()

The ARN of an Amazon Kinesis stream to which to deliver matching log events.

Returns:

The ARN of an Amazon Kinesis stream to which to deliver matching log events.

roleArn

public final String roleArn()

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

Returns:

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

tags

public final Map<String,String> tags()

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging Amazon Web Services resources

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 hasTags() method.

Returns:

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging Amazon Web Services resources

toBuilder

public PutDestinationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutDestinationRequest.Builder,PutDestinationRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

builder

public static PutDestinationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutDestinationRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo