Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.glacier.model;
 
 
Container for the parameters to the SetVaultNotifications operation.

This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.

To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic.

Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:

  • ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob.
  • InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .

For conceptual information and underlying REST API, go to Configuring Vault Notifications in Amazon Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide .

 
 public class SetVaultNotificationsRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
 
     private String accountId;

    
The name of the vault.
 
     private String vaultName;

    
Provides options for specifying notification configuration.
 
Default constructor for a new SetVaultNotificationsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
 
     public SetVaultNotificationsRequest() {}
    
    
Constructs a new SetVaultNotificationsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:
vaultName The name of the vault.
vaultNotificationConfig Provides options for specifying notification configuration.
    public SetVaultNotificationsRequest(String vaultNameVaultNotificationConfig vaultNotificationConfig) {
        setVaultName(vaultName);
        setVaultNotificationConfig(vaultNotificationConfig);
    }

    
Constructs a new SetVaultNotificationsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:
accountId The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
vaultName The name of the vault.
vaultNotificationConfig Provides options for specifying notification configuration.
    public SetVaultNotificationsRequest(String accountIdString vaultNameVaultNotificationConfig vaultNotificationConfig) {
        setAccountId(accountId);
        setVaultName(vaultName);
        setVaultNotificationConfig(vaultNotificationConfig);
    }

    
The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Returns:
The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
    public String getAccountId() {
        return ;
    }
    
    
The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Parameters:
accountId The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
    public void setAccountId(String accountId) {
        this. = accountId;
    }
    
    
The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

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

Parameters:
accountId The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
Returns:
A reference to this updated object so that method calls can be chained together.
    public SetVaultNotificationsRequest withAccountId(String accountId) {
        this. = accountId;
        return this;
    }

    
The name of the vault.

Returns:
The name of the vault.
    public String getVaultName() {
        return ;
    }
    
    
The name of the vault.

Parameters:
vaultName The name of the vault.
    public void setVaultName(String vaultName) {
        this. = vaultName;
    }
    
    
The name of the vault.

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

Parameters:
vaultName The name of the vault.
Returns:
A reference to this updated object so that method calls can be chained together.
    public SetVaultNotificationsRequest withVaultName(String vaultName) {
        this. = vaultName;
        return this;
    }

    
Provides options for specifying notification configuration.

Returns:
Provides options for specifying notification configuration.
        return ;
    }
    
    
Provides options for specifying notification configuration.

Parameters:
vaultNotificationConfig Provides options for specifying notification configuration.
    public void setVaultNotificationConfig(VaultNotificationConfig vaultNotificationConfig) {
        this. = vaultNotificationConfig;
    }
    
    
Provides options for specifying notification configuration.

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

Parameters:
vaultNotificationConfig Provides options for specifying notification configuration.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = vaultNotificationConfig;
        return this;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getAccountId() != nullsb.append("AccountId: " + getAccountId() + ",");
        if (getVaultName() != nullsb.append("VaultName: " + getVaultName() + ",");
        if (getVaultNotificationConfig() != nullsb.append("VaultNotificationConfig: " + getVaultNotificationConfig() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getAccountId() == null) ? 0 : getAccountId().hashCode()); 
        hashCode = prime * hashCode + ((getVaultName() == null) ? 0 : getVaultName().hashCode()); 
        hashCode = prime * hashCode + ((getVaultNotificationConfig() == null) ? 0 : getVaultNotificationConfig().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof SetVaultNotificationsRequest == falsereturn false;
        
        if (other.getAccountId() == null ^ this.getAccountId() == nullreturn false;
        if (other.getAccountId() != null && other.getAccountId().equals(this.getAccountId()) == falsereturn false
        if (other.getVaultName() == null ^ this.getVaultName() == nullreturn false;
        if (other.getVaultName() != null && other.getVaultName().equals(this.getVaultName()) == falsereturn false
        if (other.getVaultNotificationConfig() == null ^ this.getVaultNotificationConfig() == nullreturn false;
        if (other.getVaultNotificationConfig() != null && other.getVaultNotificationConfig().equals(this.getVaultNotificationConfig()) == falsereturn false
        return true;
    }
    
    @Override
        
            return (SetVaultNotificationsRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X