com.amazonaws.services.groundstation.model.CreateEphemerisRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-groundstation Show documentation
/*
* Copyright 2019-2024 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.groundstation.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateEphemerisRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Whether to set the ephemeris status to ENABLED after validation.
*
*
* Setting this to false will set the ephemeris status to DISABLED after validation.
*
*/
private Boolean enabled;
/**
*
* Ephemeris data.
*
*/
private EphemerisData ephemeris;
/**
*
* An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
*
*/
private java.util.Date expirationTime;
/**
*
* The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
*
*/
private String kmsKeyArn;
/**
*
* A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
*
*/
private String name;
/**
*
* Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
*
*
* The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
*
*
* Priority must be 1 or greater
*
*/
private Integer priority;
/**
*
* AWS Ground Station satellite ID for this ephemeris.
*
*/
private String satelliteId;
/**
*
* Tags assigned to an ephemeris.
*
*/
private java.util.Map tags;
/**
*
* Whether to set the ephemeris status to ENABLED after validation.
*
*
* Setting this to false will set the ephemeris status to DISABLED after validation.
*
*
* @param enabled
* Whether to set the ephemeris status to ENABLED after validation.
*
* Setting this to false will set the ephemeris status to DISABLED after validation.
*/
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
/**
*
* Whether to set the ephemeris status to ENABLED after validation.
*
*
* Setting this to false will set the ephemeris status to DISABLED after validation.
*
*
* @return Whether to set the ephemeris status to ENABLED after validation.
*
* Setting this to false will set the ephemeris status to DISABLED after validation.
*/
public Boolean getEnabled() {
return this.enabled;
}
/**
*
* Whether to set the ephemeris status to ENABLED after validation.
*
*
* Setting this to false will set the ephemeris status to DISABLED after validation.
*
*
* @param enabled
* Whether to set the ephemeris status to ENABLED after validation.
*
* Setting this to false will set the ephemeris status to DISABLED after validation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEphemerisRequest withEnabled(Boolean enabled) {
setEnabled(enabled);
return this;
}
/**
*
* Whether to set the ephemeris status to ENABLED after validation.
*
*
* Setting this to false will set the ephemeris status to DISABLED after validation.
*
*
* @return Whether to set the ephemeris status to ENABLED after validation.
*
* Setting this to false will set the ephemeris status to DISABLED after validation.
*/
public Boolean isEnabled() {
return this.enabled;
}
/**
*
* Ephemeris data.
*
*
* @param ephemeris
* Ephemeris data.
*/
public void setEphemeris(EphemerisData ephemeris) {
this.ephemeris = ephemeris;
}
/**
*
* Ephemeris data.
*
*
* @return Ephemeris data.
*/
public EphemerisData getEphemeris() {
return this.ephemeris;
}
/**
*
* Ephemeris data.
*
*
* @param ephemeris
* Ephemeris data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEphemerisRequest withEphemeris(EphemerisData ephemeris) {
setEphemeris(ephemeris);
return this;
}
/**
*
* An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
*
*
* @param expirationTime
* An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
*/
public void setExpirationTime(java.util.Date expirationTime) {
this.expirationTime = expirationTime;
}
/**
*
* An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
*
*
* @return An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
*/
public java.util.Date getExpirationTime() {
return this.expirationTime;
}
/**
*
* An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
*
*
* @param expirationTime
* An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEphemerisRequest withExpirationTime(java.util.Date expirationTime) {
setExpirationTime(expirationTime);
return this;
}
/**
*
* The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
*
*
* @param kmsKeyArn
* The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
*/
public void setKmsKeyArn(String kmsKeyArn) {
this.kmsKeyArn = kmsKeyArn;
}
/**
*
* The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
*
*
* @return The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
*/
public String getKmsKeyArn() {
return this.kmsKeyArn;
}
/**
*
* The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
*
*
* @param kmsKeyArn
* The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEphemerisRequest withKmsKeyArn(String kmsKeyArn) {
setKmsKeyArn(kmsKeyArn);
return this;
}
/**
*
* A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
*
*
* @param name
* A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
*
*
* @return A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
*/
public String getName() {
return this.name;
}
/**
*
* A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
*
*
* @param name
* A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEphemerisRequest withName(String name) {
setName(name);
return this;
}
/**
*
* Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
*
*
* The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
*
*
* Priority must be 1 or greater
*
*
* @param priority
* Customer-provided priority score to establish the order in which overlapping ephemerides should be
* used.
*
* The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
*
*
* Priority must be 1 or greater
*/
public void setPriority(Integer priority) {
this.priority = priority;
}
/**
*
* Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
*
*
* The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
*
*
* Priority must be 1 or greater
*
*
* @return Customer-provided priority score to establish the order in which overlapping ephemerides should be
* used.
*
* The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
*
*
* Priority must be 1 or greater
*/
public Integer getPriority() {
return this.priority;
}
/**
*
* Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
*
*
* The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
*
*
* Priority must be 1 or greater
*
*
* @param priority
* Customer-provided priority score to establish the order in which overlapping ephemerides should be
* used.
*
* The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
*
*
* Priority must be 1 or greater
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEphemerisRequest withPriority(Integer priority) {
setPriority(priority);
return this;
}
/**
*
* AWS Ground Station satellite ID for this ephemeris.
*
*
* @param satelliteId
* AWS Ground Station satellite ID for this ephemeris.
*/
public void setSatelliteId(String satelliteId) {
this.satelliteId = satelliteId;
}
/**
*
* AWS Ground Station satellite ID for this ephemeris.
*
*
* @return AWS Ground Station satellite ID for this ephemeris.
*/
public String getSatelliteId() {
return this.satelliteId;
}
/**
*
* AWS Ground Station satellite ID for this ephemeris.
*
*
* @param satelliteId
* AWS Ground Station satellite ID for this ephemeris.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEphemerisRequest withSatelliteId(String satelliteId) {
setSatelliteId(satelliteId);
return this;
}
/**
*
* Tags assigned to an ephemeris.
*
*
* @return Tags assigned to an ephemeris.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* Tags assigned to an ephemeris.
*
*
* @param tags
* Tags assigned to an ephemeris.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* Tags assigned to an ephemeris.
*
*
* @param tags
* Tags assigned to an ephemeris.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEphemerisRequest withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreateEphemerisRequest#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateEphemerisRequest addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEphemerisRequest clearTagsEntries() {
this.tags = null;
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEnabled() != null)
sb.append("Enabled: ").append(getEnabled()).append(",");
if (getEphemeris() != null)
sb.append("Ephemeris: ").append(getEphemeris()).append(",");
if (getExpirationTime() != null)
sb.append("ExpirationTime: ").append(getExpirationTime()).append(",");
if (getKmsKeyArn() != null)
sb.append("KmsKeyArn: ").append(getKmsKeyArn()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getPriority() != null)
sb.append("Priority: ").append(getPriority()).append(",");
if (getSatelliteId() != null)
sb.append("SatelliteId: ").append(getSatelliteId()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateEphemerisRequest == false)
return false;
CreateEphemerisRequest other = (CreateEphemerisRequest) obj;
if (other.getEnabled() == null ^ this.getEnabled() == null)
return false;
if (other.getEnabled() != null && other.getEnabled().equals(this.getEnabled()) == false)
return false;
if (other.getEphemeris() == null ^ this.getEphemeris() == null)
return false;
if (other.getEphemeris() != null && other.getEphemeris().equals(this.getEphemeris()) == false)
return false;
if (other.getExpirationTime() == null ^ this.getExpirationTime() == null)
return false;
if (other.getExpirationTime() != null && other.getExpirationTime().equals(this.getExpirationTime()) == false)
return false;
if (other.getKmsKeyArn() == null ^ this.getKmsKeyArn() == null)
return false;
if (other.getKmsKeyArn() != null && other.getKmsKeyArn().equals(this.getKmsKeyArn()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getPriority() == null ^ this.getPriority() == null)
return false;
if (other.getPriority() != null && other.getPriority().equals(this.getPriority()) == false)
return false;
if (other.getSatelliteId() == null ^ this.getSatelliteId() == null)
return false;
if (other.getSatelliteId() != null && other.getSatelliteId().equals(this.getSatelliteId()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEnabled() == null) ? 0 : getEnabled().hashCode());
hashCode = prime * hashCode + ((getEphemeris() == null) ? 0 : getEphemeris().hashCode());
hashCode = prime * hashCode + ((getExpirationTime() == null) ? 0 : getExpirationTime().hashCode());
hashCode = prime * hashCode + ((getKmsKeyArn() == null) ? 0 : getKmsKeyArn().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getPriority() == null) ? 0 : getPriority().hashCode());
hashCode = prime * hashCode + ((getSatelliteId() == null) ? 0 : getSatelliteId().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateEphemerisRequest clone() {
return (CreateEphemerisRequest) super.clone();
}
}