com.amazonaws.services.simplesystemsmanagement.model.MaintenanceWindowLambdaParameters Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssm 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.simplesystemsmanagement.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The parameters for a LAMBDA task type.
*
*
* For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and
* UpdateMaintenanceWindowTask.
*
*
*
* LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to
* contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the
* TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager
* handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use
* the Parameters option in the TaskInvocationParameters structure. For information about how
* Systems Manager handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* For Lambda tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.
*
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class MaintenanceWindowLambdaParameters implements Serializable, Cloneable, StructuredPojo {
/**
*
* Pass client-specific information to the Lambda function that you are invoking. You can then process the client
* information in your Lambda function as you choose through the context variable.
*
*/
private String clientContext;
/**
*
* (Optional) Specify an Lambda function version or alias name. If you specify a function version, the operation
* uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an
* alias name, the operation uses the alias ARN to invoke the Lambda function version to which the alias points.
*
*/
private String qualifier;
/**
*
* JSON to provide to your Lambda function as input.
*
*/
private java.nio.ByteBuffer payload;
/**
*
* Pass client-specific information to the Lambda function that you are invoking. You can then process the client
* information in your Lambda function as you choose through the context variable.
*
*
* @param clientContext
* Pass client-specific information to the Lambda function that you are invoking. You can then process the
* client information in your Lambda function as you choose through the context variable.
*/
public void setClientContext(String clientContext) {
this.clientContext = clientContext;
}
/**
*
* Pass client-specific information to the Lambda function that you are invoking. You can then process the client
* information in your Lambda function as you choose through the context variable.
*
*
* @return Pass client-specific information to the Lambda function that you are invoking. You can then process the
* client information in your Lambda function as you choose through the context variable.
*/
public String getClientContext() {
return this.clientContext;
}
/**
*
* Pass client-specific information to the Lambda function that you are invoking. You can then process the client
* information in your Lambda function as you choose through the context variable.
*
*
* @param clientContext
* Pass client-specific information to the Lambda function that you are invoking. You can then process the
* client information in your Lambda function as you choose through the context variable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MaintenanceWindowLambdaParameters withClientContext(String clientContext) {
setClientContext(clientContext);
return this;
}
/**
*
* (Optional) Specify an Lambda function version or alias name. If you specify a function version, the operation
* uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an
* alias name, the operation uses the alias ARN to invoke the Lambda function version to which the alias points.
*
*
* @param qualifier
* (Optional) Specify an Lambda function version or alias name. If you specify a function version, the
* operation uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If
* you specify an alias name, the operation uses the alias ARN to invoke the Lambda function version to which
* the alias points.
*/
public void setQualifier(String qualifier) {
this.qualifier = qualifier;
}
/**
*
* (Optional) Specify an Lambda function version or alias name. If you specify a function version, the operation
* uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an
* alias name, the operation uses the alias ARN to invoke the Lambda function version to which the alias points.
*
*
* @return (Optional) Specify an Lambda function version or alias name. If you specify a function version, the
* operation uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If
* you specify an alias name, the operation uses the alias ARN to invoke the Lambda function version to
* which the alias points.
*/
public String getQualifier() {
return this.qualifier;
}
/**
*
* (Optional) Specify an Lambda function version or alias name. If you specify a function version, the operation
* uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an
* alias name, the operation uses the alias ARN to invoke the Lambda function version to which the alias points.
*
*
* @param qualifier
* (Optional) Specify an Lambda function version or alias name. If you specify a function version, the
* operation uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If
* you specify an alias name, the operation uses the alias ARN to invoke the Lambda function version to which
* the alias points.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MaintenanceWindowLambdaParameters withQualifier(String qualifier) {
setQualifier(qualifier);
return this;
}
/**
*
* JSON to provide to your Lambda function as input.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param payload
* JSON to provide to your Lambda function as input.
*/
public void setPayload(java.nio.ByteBuffer payload) {
this.payload = payload;
}
/**
*
* JSON to provide to your Lambda function as input.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return JSON to provide to your Lambda function as input.
*/
public java.nio.ByteBuffer getPayload() {
return this.payload;
}
/**
*
* JSON to provide to your Lambda function as input.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param payload
* JSON to provide to your Lambda function as input.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MaintenanceWindowLambdaParameters withPayload(java.nio.ByteBuffer payload) {
setPayload(payload);
return this;
}
/**
*
* JSON to provide to your Lambda function as input.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param payload
* JSON to provide to your Lambda function as input.
*/
public void setPayload(String payload) {
setPayload(new com.amazonaws.adapters.types.StringToByteBufferAdapter().adapt(payload));
}
/**
*
* JSON to provide to your Lambda function as input.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param payload
* JSON to provide to your Lambda function as input.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MaintenanceWindowLambdaParameters withPayload(String payload) {
setPayload(new com.amazonaws.adapters.types.StringToByteBufferAdapter().adapt(payload));
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 (getClientContext() != null)
sb.append("ClientContext: ").append(getClientContext()).append(",");
if (getQualifier() != null)
sb.append("Qualifier: ").append(getQualifier()).append(",");
if (getPayload() != null)
sb.append("Payload: ").append("***Sensitive Data Redacted***");
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof MaintenanceWindowLambdaParameters == false)
return false;
MaintenanceWindowLambdaParameters other = (MaintenanceWindowLambdaParameters) obj;
if (other.getClientContext() == null ^ this.getClientContext() == null)
return false;
if (other.getClientContext() != null && other.getClientContext().equals(this.getClientContext()) == false)
return false;
if (other.getQualifier() == null ^ this.getQualifier() == null)
return false;
if (other.getQualifier() != null && other.getQualifier().equals(this.getQualifier()) == false)
return false;
if (other.getPayload() == null ^ this.getPayload() == null)
return false;
if (other.getPayload() != null && other.getPayload().equals(this.getPayload()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getClientContext() == null) ? 0 : getClientContext().hashCode());
hashCode = prime * hashCode + ((getQualifier() == null) ? 0 : getQualifier().hashCode());
hashCode = prime * hashCode + ((getPayload() == null) ? 0 : getPayload().hashCode());
return hashCode;
}
@Override
public MaintenanceWindowLambdaParameters clone() {
try {
return (MaintenanceWindowLambdaParameters) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.simplesystemsmanagement.model.transform.MaintenanceWindowLambdaParametersMarshaller.getInstance().marshall(this,
protocolMarshaller);
}
}