Package software.amazon.smithy.docgen.sections

Record Class LifecycleOperationSection

java.lang.Object

java.lang.Record

software.amazon.smithy.docgen.sections.LifecycleOperationSection

Record Components:

context - The context used to generate documentation.

resource - The resource the operation is bound to.

operation - The lifecycle operation being listed.

lifecycleType - The type of lifecycle binding.

All Implemented Interfaces:

CodeSection

public record LifecycleOperationSection(DocGenerationContext context, ResourceShape resource, OperationShape operation, LifecycleOperationSection.LifecycleType lifecycleType)
extends Record
implements CodeSection

Contains the documentation for individual resource lifecycle operations.

See Also:

• For the section containing all the resource lifecycle operations.
• For individual operations bound to the resource's operations or collectionOperations properties.
• For all operations bound to the resource's operations or collectionOperations properties.
• for information about other sections present on the documentation pages for resrouces.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LifecycleOperationSection.LifecycleType	The type of lifecycle binding an operation can use.

Constructor Summary

Constructors

Constructor	Description
LifecycleOperationSection(DocGenerationContext context, ResourceShape resource, OperationShape operation, LifecycleOperationSection.LifecycleType lifecycleType)	Creates an instance of a LifecycleOperationSection record class.

Method Summary

Modifier and Type	Method	Description
DocGenerationContext	context()	Returns the value of the context record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
LifecycleOperationSection.LifecycleType	lifecycleType()	Returns the value of the lifecycleType record component.
OperationShape	operation()	Returns the value of the operation record component.
ResourceShape	resource()	Returns the value of the resource record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.utils.CodeSection

sectionName

Constructor Details

LifecycleOperationSection

public LifecycleOperationSection(DocGenerationContext context,
 ResourceShape resource,
 OperationShape operation,
 LifecycleOperationSection.LifecycleType lifecycleType)

Creates an instance of a LifecycleOperationSection record class.

Parameters:

context - the value for the context record component

resource - the value for the resource record component

operation - the value for the operation record component

lifecycleType - the value for the lifecycleType record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

context

public DocGenerationContext context()

Returns the value of the context record component.

Returns:

the value of the context record component

resource

public ResourceShape resource()

Returns the value of the resource record component.

Returns:

the value of the resource record component

operation

public OperationShape operation()

Returns the value of the operation record component.

Returns:

the value of the operation record component

lifecycleType

public LifecycleOperationSection.LifecycleType lifecycleType()

Returns the value of the lifecycleType record component.

Returns:

the value of the lifecycleType record component