Package software.amazon.awssdk.services.lightsail.model

Class GetContainerLogRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lightsail.model.LightsailRequest

software.amazon.awssdk.services.lightsail.model.GetContainerLogRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetContainerLogRequest.Builder,GetContainerLogRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetContainerLogRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetContainerLogRequest.Builder	builder()
String	containerName()	The name of the container that is either running or previously ran on the container service for which to return a log.
Instant	endTime()	The end of the time interval for which to get log data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterPattern()	The pattern to use to filter the returned log events to a specific term.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	pageToken()	The token to advance to the next page of results from your request.
List<SdkField<?>>	sdkFields()
static Class<? extends GetContainerLogRequest.Builder>	serializableBuilderClass()
String	serviceName()	The name of the container service for which to get a container log.
Instant	startTime()	The start of the time interval for which to get log data.
GetContainerLogRequest.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

serviceName

public final String serviceName()

The name of the container service for which to get a container log.

Returns:

The name of the container service for which to get a container log.

containerName

public final String containerName()

The name of the container that is either running or previously ran on the container service for which to return a log.

Returns:

The name of the container that is either running or previously ran on the container service for which to return a log.

startTime

public final Instant startTime()

The start of the time interval for which to get log data.

Constraints:

• Specified in Coordinated Universal Time (UTC).

• Specified in the Unix time format.

  For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Returns:

The start of the time interval for which to get log data.

Constraints:

• Specified in Coordinated Universal Time (UTC).

• Specified in the Unix time format.

  For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

endTime

public final Instant endTime()

The end of the time interval for which to get log data.

Constraints:

• Specified in Coordinated Universal Time (UTC).

• Specified in the Unix time format.

  For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Returns:

The end of the time interval for which to get log data.

Constraints:

• Specified in Coordinated Universal Time (UTC).

• Specified in the Unix time format.

  For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

filterPattern

public final String filterPattern()

The pattern to use to filter the returned log events to a specific term.

The following are a few examples of filter patterns that you can specify:

• To return all log events, specify a filter pattern of "".

• To exclude log events that contain the ERROR term, and return all other log events, specify a filter pattern of "-ERROR".

• To return log events that contain the ERROR term, specify a filter pattern of "ERROR".

• To return log events that contain both the ERROR and Exception terms, specify a filter pattern of "ERROR Exception".

• To return log events that contain the ERROR or the Exception term, specify a filter pattern of "?ERROR ?Exception".

Returns:

The pattern to use to filter the returned log events to a specific term.

The following are a few examples of filter patterns that you can specify:

• To return all log events, specify a filter pattern of "".

• To exclude log events that contain the ERROR term, and return all other log events, specify a filter pattern of "-ERROR".

• To return log events that contain the ERROR term, specify a filter pattern of "ERROR".

• To return log events that contain both the ERROR and Exception terms, specify a filter pattern of "ERROR Exception".

• To return log events that contain the ERROR or the Exception term, specify a filter pattern of "?ERROR ?Exception".

pageToken

public final String pageToken()

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetContainerLog request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Returns:

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetContainerLog request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

toBuilder

public GetContainerLogRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetContainerLogRequest.Builder,GetContainerLogRequest>

Specified by:

toBuilder in class LightsailRequest

builder

public static GetContainerLogRequest.Builder builder()

serializableBuilderClass

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