Interface GetContainerLogRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetContainerLogRequest.Builder,
,GetContainerLogRequest> LightsailRequest.Builder
,SdkBuilder<GetContainerLogRequest.Builder,
,GetContainerLogRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetContainerLogRequest
-
Method Summary
Modifier and TypeMethodDescriptioncontainerName
(String containerName) The name of the container that is either running or previously ran on the container service for which to return a log.The end of the time interval for which to get log data.filterPattern
(String filterPattern) The pattern to use to filter the returned log events to a specific term.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The token to advance to the next page of results from your request.serviceName
(String serviceName) The name of the container service for which to get a container log.The start of the time interval for which to get log data.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.lightsail.model.LightsailRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
serviceName
The name of the container service for which to get a container log.
- Parameters:
serviceName
- The name of the container service for which to get a container log.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
containerName
The name of the container that is either running or previously ran on the container service for which to return a log.
- Parameters:
containerName
- The name of the container that is either running or previously ran on the container service for which to return a log.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
andException
terms, specify a filter pattern of"ERROR Exception"
. -
To return log events that contain the
ERROR
or theException
term, specify a filter pattern of"?ERROR ?Exception"
.
- Parameters:
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
andException
terms, specify a filter pattern of"ERROR Exception"
. -
To return log events that contain the
ERROR
or theException
term, specify a filter pattern of"?ERROR ?Exception"
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetContainerLogRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetContainerLogRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-