com.amazonaws.services.glacier.model

## クラス JobParameters

- java.lang.Object
- - com.amazonaws.services.glacier.model.JobParameters

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

      public class JobParameters
      extends java.lang.Object
      implements java.io.Serializable

  Provides options for defining a job.

  関連項目:
    直列化された形式

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

    コンストラクタ
    コンストラクタと説明
    `JobParameters()` Default constructor for a new JobParameters object.
    `JobParameters(java.lang.String format, java.lang.String type, java.lang.String archiveId, java.lang.String description)` Constructs a new JobParameters object.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getArchiveId()` The ID of the archive that you want to retrieve.
    `java.lang.String` | `getDescription()` The optional description for the job.
    `java.lang.String` | `getFormat()` When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format.
    `java.lang.String` | `getRetrievalByteRange()` Returns the value of the RetrievalByteRange property for this object.
    `java.lang.String` | `getSNSTopic()` The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download.
    `java.lang.String` | `getType()` The job type.
    `int` | `hashCode()`
    `void` | `setArchiveId(java.lang.String archiveId)` The ID of the archive that you want to retrieve.
    `void` | `setDescription(java.lang.String description)` The optional description for the job.
    `void` | `setFormat(java.lang.String format)` When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format.
    `void` | `setRetrievalByteRange(java.lang.String retrievalByteRange)` Sets the value of the RetrievalByteRange property for this object.
    `void` | `setSNSTopic(java.lang.String sNSTopic)` The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download.
    `void` | `setType(java.lang.String type)` The job type.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `JobParameters` | `withArchiveId(java.lang.String archiveId)` The ID of the archive that you want to retrieve.
    `JobParameters` | `withDescription(java.lang.String description)` The optional description for the job.
    `JobParameters` | `withFormat(java.lang.String format)` When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format.
    `JobParameters` | `withRetrievalByteRange(java.lang.String retrievalByteRange)` Sets the value of the RetrievalByteRange property for this object.
    `JobParameters` | `withSNSTopic(java.lang.String sNSTopic)` The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download.
    `JobParameters` | `withType(java.lang.String type)` The job type.

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

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

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

    - #### JobParameters

          public JobParameters()

      Default constructor for a new JobParameters object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

    - #### JobParameters

          public JobParameters(java.lang.String format,
                       java.lang.String type,
                       java.lang.String archiveId,
                       java.lang.String description)

      Constructs a new JobParameters object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      パラメータ:
        `format` - When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid Values are "CSV" and "JSON".
        `type` - The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid Values are "archive-retrieval" and "inventory-retrieval".
        `archiveId` - The ID of the archive that you want to retrieve. This field is required only if `Type` is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.
        `description` - The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes���specifically, ASCII values 32���126 decimal or 0x20���0x7E hexadecimal.

  - ### メソッドの詳細

    - #### getFormat

          public java.lang.String getFormat()

      When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid Values are "CSV" and "JSON".
      戻り値:
        When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid Values are "CSV" and "JSON".

    - #### setFormat

          public void setFormat(java.lang.String format)

      When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid Values are "CSV" and "JSON".
      パラメータ:
        `format` - When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid Values are "CSV" and "JSON".

    - #### withFormat

          public JobParameters withFormat(java.lang.String format)

      When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid Values are "CSV" and "JSON".

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

      パラメータ:
        `format` - When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid Values are "CSV" and "JSON".

    - #### getType

          public java.lang.String getType()

      The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid Values are "archive-retrieval" and "inventory-retrieval".
      戻り値:
        The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid Values are "archive-retrieval" and "inventory-retrieval".

    - #### setType

          public void setType(java.lang.String type)

      The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid Values are "archive-retrieval" and "inventory-retrieval".
      パラメータ:
        `type` - The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid Values are "archive-retrieval" and "inventory-retrieval".

    - #### withType

          public JobParameters withType(java.lang.String type)

      The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid Values are "archive-retrieval" and "inventory-retrieval".

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

      パラメータ:
        `type` - The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid Values are "archive-retrieval" and "inventory-retrieval".

    - #### getArchiveId

          public java.lang.String getArchiveId()

      The ID of the archive that you want to retrieve. This field is required only if `Type` is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.
      戻り値:
        The ID of the archive that you want to retrieve. This field is required only if `Type` is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.

    - #### setArchiveId

          public void setArchiveId(java.lang.String archiveId)

      The ID of the archive that you want to retrieve. This field is required only if `Type` is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.
      パラメータ:
        `archiveId` - The ID of the archive that you want to retrieve. This field is required only if `Type` is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.

    - #### withArchiveId

          public JobParameters withArchiveId(java.lang.String archiveId)

      The ID of the archive that you want to retrieve. This field is required only if `Type` is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.

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

      パラメータ:
        `archiveId` - The ID of the archive that you want to retrieve. This field is required only if `Type` is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.

    - #### getDescription

          public java.lang.String getDescription()

      The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes���specifically, ASCII values 32���126 decimal or 0x20���0x7E hexadecimal.
      戻り値:
        The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes���specifically, ASCII values 32���126 decimal or 0x20���0x7E hexadecimal.

    - #### setDescription

          public void setDescription(java.lang.String description)

      The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes���specifically, ASCII values 32���126 decimal or 0x20���0x7E hexadecimal.
      パラメータ:
        `description` - The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes���specifically, ASCII values 32���126 decimal or 0x20���0x7E hexadecimal.

    - #### withDescription

          public JobParameters withDescription(java.lang.String description)

      The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes���specifically, ASCII values 32���126 decimal or 0x20���0x7E hexadecimal.

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

      パラメータ:
        `description` - The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes���specifically, ASCII values 32���126 decimal or 0x20���0x7E hexadecimal.

    - #### getSNSTopic

          public java.lang.String getSNSTopic()

      The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.
      戻り値:
        The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

    - #### setSNSTopic

          public void setSNSTopic(java.lang.String sNSTopic)

      The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.
      パラメータ:
        `sNSTopic` - The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

    - #### withSNSTopic

          public JobParameters withSNSTopic(java.lang.String sNSTopic)

      The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

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

      パラメータ:
        `sNSTopic` - The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

    - #### getRetrievalByteRange

          public java.lang.String getRetrievalByteRange()

      Returns the value of the RetrievalByteRange property for this object.
      戻り値:
        The value of the RetrievalByteRange property for this object.

    - #### setRetrievalByteRange

          public void setRetrievalByteRange(java.lang.String retrievalByteRange)

      Sets the value of the RetrievalByteRange property for this object.
      パラメータ:
        `retrievalByteRange` - The new value for the RetrievalByteRange property for this object.

    - #### withRetrievalByteRange

          public JobParameters withRetrievalByteRange(java.lang.String retrievalByteRange)

      Sets the value of the RetrievalByteRange property for this object.

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

      パラメータ:
        `retrievalByteRange` - The new value for the RetrievalByteRange property for this object.

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