com.amazonaws.services.datapipeline.model

## クラス QueryObjectsRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.datapipeline.model.QueryObjectsRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class QueryObjectsRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  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` .

  関連項目:
    `DataPipeline.queryObjects(QueryObjectsRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `QueryObjectsRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.Integer` | `getLimit()` Specifies the maximum number of object names that QueryObjects will return in a single call.
    `java.lang.String` | `getMarker()` The starting point for the results to be returned.
    `java.lang.String` | `getPipelineId()` Identifier of the pipeline to be queried for object names.
    `Query` | `getQuery()` Query that defines the objects to be returned.
    `java.lang.String` | `getSphere()` Specifies whether the query applies to components or instances.
    `int` | `hashCode()`
    `void` | `setLimit(java.lang.Integer limit)` Specifies the maximum number of object names that QueryObjects will return in a single call.
    `void` | `setMarker(java.lang.String marker)` The starting point for the results to be returned.
    `void` | `setPipelineId(java.lang.String pipelineId)` Identifier of the pipeline to be queried for object names.
    `void` | `setQuery(Query query)` Query that defines the objects to be returned.
    `void` | `setSphere(java.lang.String sphere)` Specifies whether the query applies to components or instances.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `QueryObjectsRequest` | `withLimit(java.lang.Integer limit)` Specifies the maximum number of object names that QueryObjects will return in a single call.
    `QueryObjectsRequest` | `withMarker(java.lang.String marker)` The starting point for the results to be returned.
    `QueryObjectsRequest` | `withPipelineId(java.lang.String pipelineId)` Identifier of the pipeline to be queried for object names.
    `QueryObjectsRequest` | `withQuery(Query query)` Query that defines the objects to be returned.
    `QueryObjectsRequest` | `withSphere(java.lang.String sphere)` Specifies whether the query applies to components or instances.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### QueryObjectsRequest

          public QueryObjectsRequest()

  - ### メソッドの詳細

    - #### getPipelineId

          public java.lang.String getPipelineId()

      Identifier of the pipeline to be queried for object names.

      Constraints:
      Length: 1 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      戻り値:
        Identifier of the pipeline to be queried for object names.

    - #### setPipelineId

          public void setPipelineId(java.lang.String pipelineId)

      Identifier of the pipeline to be queried for object names.

      Constraints:
      Length: 1 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `pipelineId` - Identifier of the pipeline to be queried for object names.

    - #### withPipelineId

          public QueryObjectsRequest withPipelineId(java.lang.String pipelineId)

      Identifier of the pipeline to be queried for object names.

      Returns a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 1 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `pipelineId` - Identifier of the pipeline to be queried for object names.

    - #### getQuery

          public Query getQuery()

      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.
      戻り値:
        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.

    - #### setQuery

          public void setQuery(Query 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.
      パラメータ:
        `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.

    - #### withQuery

          public QueryObjectsRequest withQuery(Query 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.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `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.

    - #### getSphere

          public java.lang.String getSphere()

      Specifies whether the query applies to components or instances. Allowable values: `COMPONENT`, `INSTANCE`, `ATTEMPT`.

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      戻り値:
        Specifies whether the query applies to components or instances. Allowable values: `COMPONENT`, `INSTANCE`, `ATTEMPT`.

    - #### setSphere

          public void setSphere(java.lang.String sphere)

      Specifies whether the query applies to components or instances. Allowable values: `COMPONENT`, `INSTANCE`, `ATTEMPT`.

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `sphere` - Specifies whether the query applies to components or instances. Allowable values: `COMPONENT`, `INSTANCE`, `ATTEMPT`.

    - #### withSphere

          public QueryObjectsRequest withSphere(java.lang.String sphere)

      Specifies whether the query applies to components or instances. Allowable values: `COMPONENT`, `INSTANCE`, `ATTEMPT`.

      Returns a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `sphere` - Specifies whether the query applies to components or instances. Allowable values: `COMPONENT`, `INSTANCE`, `ATTEMPT`.

    - #### getMarker

          public java.lang.String getMarker()

      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:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      戻り値:
        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.

    - #### setMarker

          public void setMarker(java.lang.String 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:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `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.

    - #### withMarker

          public QueryObjectsRequest withMarker(java.lang.String 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.

      Returns a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `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.

    - #### getLimit

          public java.lang.Integer getLimit()

      Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.
      戻り値:
        Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.

    - #### setLimit

          public void setLimit(java.lang.Integer limit)

      Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.
      パラメータ:
        `limit` - Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.

    - #### withLimit

          public QueryObjectsRequest withLimit(java.lang.Integer limit)

      Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `limit` - Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`