Class QueryObjectsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Contains the parameters for QueryObjects.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
getLimit()
The maximum number of object names thatQueryObjects
will return in a single call.The starting point for the results to be returned.The ID of the pipeline.getQuery()
The query that defines the objects to be returned.Indicates whether the query applies to components or instances.int
hashCode()
void
The maximum number of object names thatQueryObjects
will return in a single call.void
The starting point for the results to be returned.void
setPipelineId
(String pipelineId) The ID of the pipeline.void
The query that defines the objects to be returned.void
Indicates whether the query applies to components or instances.toString()
Returns a string representation of this object; useful for testing and debugging.The maximum number of object names thatQueryObjects
will return in a single call.withMarker
(String marker) The starting point for the results to be returned.withPipelineId
(String pipelineId) The ID of the pipeline.The query that defines the objects to be returned.withSphere
(String sphere) Indicates whether the query applies to components or instances.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
QueryObjectsRequest
public QueryObjectsRequest()
-
-
Method Details
-
setPipelineId
The ID of the pipeline.
- Parameters:
pipelineId
- The ID of the pipeline.
-
getPipelineId
The ID of the pipeline.
- Returns:
- The ID of the pipeline.
-
withPipelineId
The ID of the pipeline.
- Parameters:
pipelineId
- The ID of the pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setQuery
The query that defines the objects to be returned. The
Query
object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.- Parameters:
query
- The query that defines the objects to be returned. TheQuery
object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.
-
getQuery
The query that defines the objects to be returned. The
Query
object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.- Returns:
- The query that defines the objects to be returned. The
Query
object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.
-
withQuery
The query that defines the objects to be returned. The
Query
object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.- Parameters:
query
- The query that defines the objects to be returned. TheQuery
object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSphere
Indicates whether the query applies to components or instances. The possible values are:
COMPONENT
,INSTANCE
, andATTEMPT
.- Parameters:
sphere
- Indicates whether the query applies to components or instances. The possible values are:COMPONENT
,INSTANCE
, andATTEMPT
.
-
getSphere
Indicates whether the query applies to components or instances. The possible values are:
COMPONENT
,INSTANCE
, andATTEMPT
.- Returns:
- Indicates whether the query applies to components or instances.
The possible values are:
COMPONENT
,INSTANCE
, andATTEMPT
.
-
withSphere
Indicates whether the query applies to components or instances. The possible values are:
COMPONENT
,INSTANCE
, andATTEMPT
.- Parameters:
sphere
- Indicates whether the query applies to components or instances. The possible values are:COMPONENT
,INSTANCE
, andATTEMPT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMarker
The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call
QueryObjects
with the marker value from the previous call to retrieve the next set of results.- Parameters:
marker
- The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to callQueryObjects
with the marker value from the previous call to retrieve the next set of results.
-
getMarker
The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call
QueryObjects
with the marker value from the previous call to retrieve the next set of results.- Returns:
- The starting point for the results to be returned. For the first
call, this value should be empty. As long as there are more
results, continue to call
QueryObjects
with the marker value from the previous call to retrieve the next set of results.
-
withMarker
The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call
QueryObjects
with the marker value from the previous call to retrieve the next set of results.- Parameters:
marker
- The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to callQueryObjects
with the marker value from the previous call to retrieve the next set of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLimit
The maximum number of object names that
QueryObjects
will return in a single call. The default value is 100.- Parameters:
limit
- The maximum number of object names thatQueryObjects
will return in a single call. The default value is 100.
-
getLimit
The maximum number of object names that
QueryObjects
will return in a single call. The default value is 100.- Returns:
- The maximum number of object names that
QueryObjects
will return in a single call. The default value is 100.
-
withLimit
The maximum number of object names that
QueryObjects
will return in a single call. The default value is 100.- Parameters:
limit
- The maximum number of object names thatQueryObjects
will return in a single call. The default value is 100.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-