Container for the parameters to the QueryObjects operation.
Queries a pipeline for the names of objects that match a specified set of conditions.
The objects returned by QueryObjects are paginated and then filtered by the value you set for query. This means the action may return an empty result set with a value set for marker. If HasMoreResults is set to True , you should continue to call QueryObjects, passing in the returned value for marker, until HasMoreResults returns False .
Declaration Syntax| C# |
public class QueryObjectsRequest : AmazonWebServiceRequest
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | QueryObjectsRequest()()()() | Initializes a new instance of the QueryObjectsRequest class |
| Equals(Object) | (Inherited from Object.) |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
 | Limit |
Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.
|
| Marker |
The starting point for the results to be returned. The first time you call QueryObjects, this value should be empty. As long as the
action returns HasMoreResults as True, you can call QueryObjects again and pass the marker value from the response to
retrieve the next set of results.
Constraints: |
| PipelineId |
Identifier of the pipeline to be queried for object names.
Constraints: |
| Query |
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.
|
| Sphere |
Specifies whether the query applies to components or instances. Allowable values: COMPONENT, INSTANCE, ATTEMPT.
Constraints: |
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| WithLimit(Int32) | Obsolete.
Sets the Limit property
|
| WithMarker(String) | Obsolete.
Sets the Marker property
|
| WithPipelineId(String) | Obsolete.
Sets the PipelineId property
|
| WithQuery(Query) | Obsolete.
Sets the Query property
|
| WithSphere(String) | Obsolete.
Sets the Sphere property
|
Inheritance Hierarchy| Object | ||
 | AmazonWebServiceRequest | |
| QueryObjectsRequest | |