com.netflix.genie.common.internal.dtos.JobRequestMetadata Maven / Gradle / Ivy
/*
*
* Copyright 2018 Netflix, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License 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.netflix.genie.common.internal.dtos;
import com.google.common.collect.ImmutableMap;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;
import javax.annotation.Nullable;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.io.Serializable;
import java.util.Map;
import java.util.Optional;
/**
* Metadata gathered by the system as part of any {@link JobRequest}.
*
* @author tgianos
* @since 4.0.0
*/
@Getter
@ToString(doNotUseGetters = true)
@EqualsAndHashCode(doNotUseGetters = true)
@SuppressWarnings("checkstyle:finalclass")
public class JobRequestMetadata implements Serializable {
private static final long serialVersionUID = -8265590545951599460L;
private final boolean api;
private final ApiClientMetadata apiClientMetadata;
private final AgentClientMetadata agentClientMetadata;
@Min(0)
private final int numAttachments;
@Min(0)
private final long totalSizeOfAttachments;
@NotNull
private final Map requestHeaders;
/**
* Constructor. One of {@literal apiClientMetadata} or {@literal agentClientMetadata} is required. Both cannot be
* present.
*
* @param apiClientMetadata The metadata about the client if this request was received via API
* @param agentClientMetadata The metadata about the client if this request was received from the Agent
* @param numAttachments The number of attachments that came with this job request
* @param totalSizeOfAttachments The total size of the attachments that came with this job request
* @param requestHeaders The map of HTTP headers (filtered upstream) if this request was received via API
* @throws IllegalArgumentException If both {@literal apiClientMetadata} and {@literal agentClientMetadata} are
* missing or both are present
*/
public JobRequestMetadata(
@Nullable final ApiClientMetadata apiClientMetadata,
@Nullable final AgentClientMetadata agentClientMetadata,
final int numAttachments,
final long totalSizeOfAttachments,
@Nullable final Map requestHeaders
) throws IllegalArgumentException {
if (apiClientMetadata == null && agentClientMetadata == null) {
throw new IllegalArgumentException(
"Both apiClientMetadata and agentClientMetadata are missing. One is required."
);
}
if (apiClientMetadata != null && agentClientMetadata != null) {
throw new IllegalArgumentException(
"Both apiClientMetadata and agentClientMetadata are present. Only one should be present"
);
}
this.api = apiClientMetadata != null;
this.apiClientMetadata = apiClientMetadata;
this.agentClientMetadata = agentClientMetadata;
this.numAttachments = Math.max(numAttachments, 0);
this.totalSizeOfAttachments = Math.max(totalSizeOfAttachments, 0L);
this.requestHeaders = requestHeaders != null ? ImmutableMap.copyOf(requestHeaders) : ImmutableMap.of();
}
/**
* If the job request was sent via API this field will be populated.
*
* @return The API client metadata wrapped in an {@link Optional}
*/
public Optional getApiClientMetadata() {
return Optional.ofNullable(this.apiClientMetadata);
}
/**
* If the job request was sent via the Agent this field will be populated.
*
* @return The Agent client metadata wrapped in an {@link Optional}
*/
public Optional getAgentClientMetadata() {
return Optional.ofNullable(this.agentClientMetadata);
}
}