com.oracle.bmc.oda.requests.StartOdaInstanceRequest Maven / Gradle / Ivy
Show all versions of oci-java-sdk-shaded-full Show documentation
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.oda.requests;
import com.oracle.bmc.oda.model.*;
/**
* Example: Click here to see how to use StartOdaInstanceRequest.
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20190506")
public class StartOdaInstanceRequest extends com.oracle.bmc.requests.BmcRequest {
/** Unique Digital Assistant instance identifier. */
private String odaInstanceId;
/** Unique Digital Assistant instance identifier. */
public String getOdaInstanceId() {
return odaInstanceId;
}
/**
* The client request ID for tracing. This value is included in the opc-request-id response
* header.
*/
private String opcRequestId;
/**
* The client request ID for tracing. This value is included in the opc-request-id response
* header.
*/
public String getOpcRequestId() {
return opcRequestId;
}
/**
* For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance,
* set the {@code if-match} query parameter to the value of the {@code ETAG} header from a
* previous GET or POST response for that instance. The service updates or deletes the instance
* only if the etag that you provide matches the instance's current etag value.
*/
private String ifMatch;
/**
* For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance,
* set the {@code if-match} query parameter to the value of the {@code ETAG} header from a
* previous GET or POST response for that instance. The service updates or deletes the instance
* only if the etag that you provide matches the instance's current etag value.
*/
public String getIfMatch() {
return ifMatch;
}
/**
* A token that uniquely identifies a request so that you can retry the request if there's a
* timeout or server error without the risk of executing that same action again.
*
* Retry tokens expire after 24 hours, but they can become invalid before then if there are
* conflicting operations. For example, if an instance was deleted and purged from the system,
* then the service might reject a retry of the original creation request.
*/
private String opcRetryToken;
/**
* A token that uniquely identifies a request so that you can retry the request if there's a
* timeout or server error without the risk of executing that same action again.
*
*
Retry tokens expire after 24 hours, but they can become invalid before then if there are
* conflicting operations. For example, if an instance was deleted and purged from the system,
* then the service might reject a retry of the original creation request.
*/
public String getOpcRetryToken() {
return opcRetryToken;
}
public static class Builder
implements com.oracle.bmc.requests.BmcRequest.Builder<
StartOdaInstanceRequest, java.lang.Void> {
private com.oracle.bmc.http.client.RequestInterceptor invocationCallback = null;
private com.oracle.bmc.retrier.RetryConfiguration retryConfiguration = null;
/** Unique Digital Assistant instance identifier. */
private String odaInstanceId = null;
/**
* Unique Digital Assistant instance identifier.
*
* @param odaInstanceId the value to set
* @return this builder instance
*/
public Builder odaInstanceId(String odaInstanceId) {
this.odaInstanceId = odaInstanceId;
return this;
}
/**
* The client request ID for tracing. This value is included in the opc-request-id response
* header.
*/
private String opcRequestId = null;
/**
* The client request ID for tracing. This value is included in the opc-request-id response
* header.
*
* @param opcRequestId the value to set
* @return this builder instance
*/
public Builder opcRequestId(String opcRequestId) {
this.opcRequestId = opcRequestId;
return this;
}
/**
* For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant
* instance, set the {@code if-match} query parameter to the value of the {@code ETAG}
* header from a previous GET or POST response for that instance. The service updates or
* deletes the instance only if the etag that you provide matches the instance's current
* etag value.
*/
private String ifMatch = null;
/**
* For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant
* instance, set the {@code if-match} query parameter to the value of the {@code ETAG}
* header from a previous GET or POST response for that instance. The service updates or
* deletes the instance only if the etag that you provide matches the instance's current
* etag value.
*
* @param ifMatch the value to set
* @return this builder instance
*/
public Builder ifMatch(String ifMatch) {
this.ifMatch = ifMatch;
return this;
}
/**
* A token that uniquely identifies a request so that you can retry the request if there's a
* timeout or server error without the risk of executing that same action again.
*
*
Retry tokens expire after 24 hours, but they can become invalid before then if there
* are conflicting operations. For example, if an instance was deleted and purged from the
* system, then the service might reject a retry of the original creation request.
*/
private String opcRetryToken = null;
/**
* A token that uniquely identifies a request so that you can retry the request if there's a
* timeout or server error without the risk of executing that same action again.
*
*
Retry tokens expire after 24 hours, but they can become invalid before then if there
* are conflicting operations. For example, if an instance was deleted and purged from the
* system, then the service might reject a retry of the original creation request.
*
* @param opcRetryToken the value to set
* @return this builder instance
*/
public Builder opcRetryToken(String opcRetryToken) {
this.opcRetryToken = opcRetryToken;
return this;
}
/**
* Set the invocation callback for the request to be built.
*
* @param invocationCallback the invocation callback to be set for the request
* @return this builder instance
*/
public Builder invocationCallback(
com.oracle.bmc.http.client.RequestInterceptor invocationCallback) {
this.invocationCallback = invocationCallback;
return this;
}
/**
* Set the retry configuration for the request to be built.
*
* @param retryConfiguration the retry configuration to be used for the request
* @return this builder instance
*/
public Builder retryConfiguration(
com.oracle.bmc.retrier.RetryConfiguration retryConfiguration) {
this.retryConfiguration = retryConfiguration;
return this;
}
/**
* Copy method to populate the builder with values from the given instance.
*
* @return this builder instance
*/
public Builder copy(StartOdaInstanceRequest o) {
odaInstanceId(o.getOdaInstanceId());
opcRequestId(o.getOpcRequestId());
ifMatch(o.getIfMatch());
opcRetryToken(o.getOpcRetryToken());
invocationCallback(o.getInvocationCallback());
retryConfiguration(o.getRetryConfiguration());
return this;
}
/**
* Build the instance of StartOdaInstanceRequest as configured by this builder
*
*
Note that this method takes calls to {@link
* Builder#invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)} into account,
* while the method {@link Builder#buildWithoutInvocationCallback} does not.
*
*
This is the preferred method to build an instance.
*
* @return instance of StartOdaInstanceRequest
*/
public StartOdaInstanceRequest build() {
StartOdaInstanceRequest request = buildWithoutInvocationCallback();
request.setInvocationCallback(invocationCallback);
request.setRetryConfiguration(retryConfiguration);
return request;
}
/**
* Build the instance of StartOdaInstanceRequest as configured by this builder
*
*
Note that this method does not take calls to {@link
* Builder#invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)} into account,
* while the method {@link Builder#build} does
*
* @return instance of StartOdaInstanceRequest
*/
public StartOdaInstanceRequest buildWithoutInvocationCallback() {
StartOdaInstanceRequest request = new StartOdaInstanceRequest();
request.odaInstanceId = odaInstanceId;
request.opcRequestId = opcRequestId;
request.ifMatch = ifMatch;
request.opcRetryToken = opcRetryToken;
return request;
// new StartOdaInstanceRequest(odaInstanceId, opcRequestId, ifMatch, opcRetryToken);
}
}
/**
* Return an instance of {@link Builder} that allows you to modify request properties.
*
* @return instance of {@link Builder} that allows you to modify request properties.
*/
public Builder toBuilder() {
return new Builder()
.odaInstanceId(odaInstanceId)
.opcRequestId(opcRequestId)
.ifMatch(ifMatch)
.opcRetryToken(opcRetryToken);
}
/**
* Return a new builder for this request object.
*
* @return builder for the request object
*/
public static Builder builder() {
return new Builder();
}
@Override
public String toString() {
java.lang.StringBuilder sb = new java.lang.StringBuilder();
sb.append("(");
sb.append("super=").append(super.toString());
sb.append(",odaInstanceId=").append(String.valueOf(this.odaInstanceId));
sb.append(",opcRequestId=").append(String.valueOf(this.opcRequestId));
sb.append(",ifMatch=").append(String.valueOf(this.ifMatch));
sb.append(",opcRetryToken=").append(String.valueOf(this.opcRetryToken));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof StartOdaInstanceRequest)) {
return false;
}
StartOdaInstanceRequest other = (StartOdaInstanceRequest) o;
return super.equals(o)
&& java.util.Objects.equals(this.odaInstanceId, other.odaInstanceId)
&& java.util.Objects.equals(this.opcRequestId, other.opcRequestId)
&& java.util.Objects.equals(this.ifMatch, other.ifMatch)
&& java.util.Objects.equals(this.opcRetryToken, other.opcRetryToken);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = super.hashCode();
result =
(result * PRIME)
+ (this.odaInstanceId == null ? 43 : this.odaInstanceId.hashCode());
result = (result * PRIME) + (this.opcRequestId == null ? 43 : this.opcRequestId.hashCode());
result = (result * PRIME) + (this.ifMatch == null ? 43 : this.ifMatch.hashCode());
result =
(result * PRIME)
+ (this.opcRetryToken == null ? 43 : this.opcRetryToken.hashCode());
return result;
}
}