software.amazon.awssdk.services.iotfleetwise.model

Class CreateSignalCatalogRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseRequest

software.amazon.awssdk.services.iotfleetwise.model.CreateSignalCatalogRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSignalCatalogRequest.Builder,CreateSignalCatalogRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateSignalCatalogRequest
extends IoTFleetWiseRequest
implements ToCopyableBuilder<CreateSignalCatalogRequest.Builder,CreateSignalCatalogRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateSignalCatalogRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateSignalCatalogRequest.Builder	builder()
String	description() A brief description of the signal catalog.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNodes() For responses, this returns true if the service returned a value for the Nodes property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() The name of the signal catalog to create.
List<Node>	nodes() A list of information about nodes, which are a general abstraction of signals.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSignalCatalogRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Metadata that can be used to manage the signal catalog.
CreateSignalCatalogRequest.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

name

public final String name()

The name of the signal catalog to create.

Returns:

The name of the signal catalog to create.

description

public final String description()

A brief description of the signal catalog.

Returns:

A brief description of the signal catalog.

hasNodes

public final boolean hasNodes()

For responses, this returns true if the service returned a value for the Nodes 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.

nodes

public final List<Node> nodes()

A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.

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

Returns:

A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.

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 List<Tag> tags()

Metadata that can be used to manage the signal catalog.

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:

Metadata that can be used to manage the signal catalog.

toBuilder

public CreateSignalCatalogRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSignalCatalogRequest.Builder,CreateSignalCatalogRequest>

Specified by:

toBuilder in class IoTFleetWiseRequest

builder

public static CreateSignalCatalogRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateSignalCatalogRequest.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