Class QueryObjectsRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.datapipeline.model.QueryObjectsRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class QueryObjectsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Contains the parameters for QueryObjects.

See Also:
  • Constructor Details

    • QueryObjectsRequest

      public QueryObjectsRequest()
  • Method Details

    • setPipelineId

      public void setPipelineId(String pipelineId)

      The ID of the pipeline.

      Parameters:
      pipelineId - The ID of the pipeline.
    • getPipelineId

      public String getPipelineId()

      The ID of the pipeline.

      Returns:
      The ID of the pipeline.
    • withPipelineId

      public QueryObjectsRequest withPipelineId(String pipelineId)

      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

      public void setQuery(Query query)

      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. 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.
    • getQuery

      public Query 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

      public QueryObjectsRequest withQuery(Query query)

      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. 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:
      Returns a reference to this object so that method calls can be chained together.
    • setSphere

      public void setSphere(String sphere)

      Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

      Parameters:
      sphere - Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.
    • getSphere

      public String getSphere()

      Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

      Returns:
      Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.
    • withSphere

      public QueryObjectsRequest withSphere(String sphere)

      Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

      Parameters:
      sphere - Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMarker

      public void setMarker(String 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 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 call QueryObjects with the marker value from the previous call to retrieve the next set of results.
    • getMarker

      public String 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

      public QueryObjectsRequest withMarker(String 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 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 call QueryObjects 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

      public void setLimit(Integer limit)

      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 that QueryObjects will return in a single call. The default value is 100.
    • getLimit

      public Integer 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

      public QueryObjectsRequest withLimit(Integer limit)

      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 that QueryObjects 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

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public QueryObjectsRequest 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 class AmazonWebServiceRequest
      See Also: