Interface ListServiceLevelObjectivesRequest.Builder
- All Superinterfaces:
ApplicationSignalsRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<ListServiceLevelObjectivesRequest.Builder,
,ListServiceLevelObjectivesRequest> SdkBuilder<ListServiceLevelObjectivesRequest.Builder,
,ListServiceLevelObjectivesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListServiceLevelObjectivesRequest
-
Method Summary
Modifier and TypeMethodDescriptiondependencyConfig
(Consumer<DependencyConfig.Builder> dependencyConfig) Identifies the dependency using theDependencyKeyAttributes
andDependencyOperationName
.dependencyConfig
(DependencyConfig dependencyConfig) Identifies the dependency using theDependencyKeyAttributes
andDependencyOperationName
.includeLinkedAccounts
(Boolean includeLinkedAccounts) If you are using this operation in a monitoring account, specifytrue
to include SLO from source accounts in the returned data.keyAttributes
(Map<String, String> keyAttributes) You can use this optional field to specify which services you want to retrieve SLO information for.maxResults
(Integer maxResults) The maximum number of results to return in one operation.metricSourceTypes
(Collection<MetricSourceType> metricSourceTypes) Use this optional field to only include SLOs with the specified metric source types in the output.metricSourceTypes
(MetricSourceType... metricSourceTypes) Use this optional field to only include SLOs with the specified metric source types in the output.metricSourceTypesWithStrings
(String... metricSourceTypes) Use this optional field to only include SLOs with the specified metric source types in the output.metricSourceTypesWithStrings
(Collection<String> metricSourceTypes) Use this optional field to only include SLOs with the specified metric source types in the output.Include this value, if it was returned by the previous operation, to get the next set of service level objectives.operationName
(String operationName) The name of the operation that this SLO is associated with.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sloOwnerAwsAccountId
(String sloOwnerAwsAccountId) SLO's Amazon Web Services account ID.Methods inherited from interface software.amazon.awssdk.services.applicationsignals.model.ApplicationSignalsRequest.Builder
build
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.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
keyAttributes
You can use this optional field to specify which services you want to retrieve SLO information for.
This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- Parameters:
keyAttributes
- You can use this optional field to specify which services you want to retrieve SLO information for.This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
operationName
The name of the operation that this SLO is associated with.
- Parameters:
operationName
- The name of the operation that this SLO is associated with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dependencyConfig
Identifies the dependency using the
DependencyKeyAttributes
andDependencyOperationName
.- Parameters:
dependencyConfig
- Identifies the dependency using theDependencyKeyAttributes
andDependencyOperationName
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dependencyConfig
default ListServiceLevelObjectivesRequest.Builder dependencyConfig(Consumer<DependencyConfig.Builder> dependencyConfig) Identifies the dependency using the
This is a convenience method that creates an instance of theDependencyKeyAttributes
andDependencyOperationName
.DependencyConfig.Builder
avoiding the need to create one manually viaDependencyConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todependencyConfig(DependencyConfig)
.- Parameters:
dependencyConfig
- a consumer that will call methods onDependencyConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxResults
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
- Parameters:
maxResults
- The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
Include this value, if it was returned by the previous operation, to get the next set of service level objectives.
- Parameters:
nextToken
- Include this value, if it was returned by the previous operation, to get the next set of service level objectives.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metricSourceTypesWithStrings
ListServiceLevelObjectivesRequest.Builder metricSourceTypesWithStrings(Collection<String> metricSourceTypes) Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:
-
Service operation
-
Service dependency
-
CloudWatch metric
- Parameters:
metricSourceTypes
- Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:-
Service operation
-
Service dependency
-
CloudWatch metric
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
metricSourceTypesWithStrings
Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:
-
Service operation
-
Service dependency
-
CloudWatch metric
- Parameters:
metricSourceTypes
- Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:-
Service operation
-
Service dependency
-
CloudWatch metric
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
metricSourceTypes
ListServiceLevelObjectivesRequest.Builder metricSourceTypes(Collection<MetricSourceType> metricSourceTypes) Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:
-
Service operation
-
Service dependency
-
CloudWatch metric
- Parameters:
metricSourceTypes
- Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:-
Service operation
-
Service dependency
-
CloudWatch metric
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
metricSourceTypes
Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:
-
Service operation
-
Service dependency
-
CloudWatch metric
- Parameters:
metricSourceTypes
- Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:-
Service operation
-
Service dependency
-
CloudWatch metric
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
includeLinkedAccounts
If you are using this operation in a monitoring account, specify
true
to include SLO from source accounts in the returned data.</p> <p>When you are monitoring an account, you can use Amazon Web Services account ID in <code>KeyAttribute</code> filter for service source account and <code>SloOwnerawsaccountID</code> for SLO source account with <code>IncludeLinkedAccounts</code> to filter the returned data to only a single source account. </p>
- Parameters:
includeLinkedAccounts
- If you are using this operation in a monitoring account, specifytrue
to include SLO from source accounts in the returned data.</p> <p>When you are monitoring an account, you can use Amazon Web Services account ID in <code>KeyAttribute</code> filter for service source account and <code>SloOwnerawsaccountID</code> for SLO source account with <code>IncludeLinkedAccounts</code> to filter the returned data to only a single source account. </p>
@return Returns a reference to this object so that method calls can be chained together.
-
sloOwnerAwsAccountId
SLO's Amazon Web Services account ID.
- Parameters:
sloOwnerAwsAccountId
- SLO's Amazon Web Services account ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListServiceLevelObjectivesRequest.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
ListServiceLevelObjectivesRequest.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.
-