software.aws.awsprototypingsdk.openapigateway.IntegrationGrantProps Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of open-api-gateway Show documentation
Show all versions of open-api-gateway Show documentation
@aws-prototyping-sdk/open-api-gateway
package software.aws.awsprototypingsdk.openapigateway;
/**
* (experimental) Properties for granting the API access to invoke the operation.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.82.0 (build 2d2ddd7)", date = "2023-08-15T05:38:04.576Z")
@software.amazon.jsii.Jsii(module = software.aws.awsprototypingsdk.openapigateway.$Module.class, fqn = "@aws-prototyping-sdk/open-api-gateway.IntegrationGrantProps")
@software.amazon.jsii.Jsii.Proxy(IntegrationGrantProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface IntegrationGrantProps extends software.amazon.jsii.JsiiSerializable, software.aws.awsprototypingsdk.openapigateway.MethodAndPath {
/**
* (experimental) The api to grant permissions for.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull software.amazon.awscdk.services.apigateway.SpecRestApi getApi();
/**
* (experimental) The ID of the operation for which permissions are being granted.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getOperationId();
/**
* (experimental) The scope in which permission resources can be created.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull software.constructs.Construct getScope();
/**
* @return a {@link Builder} of {@link IntegrationGrantProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link IntegrationGrantProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
software.amazon.awscdk.services.apigateway.SpecRestApi api;
java.lang.String operationId;
software.constructs.Construct scope;
java.lang.String method;
java.lang.String path;
/**
* Sets the value of {@link IntegrationGrantProps#getApi}
* @param api The api to grant permissions for. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder api(software.amazon.awscdk.services.apigateway.SpecRestApi api) {
this.api = api;
return this;
}
/**
* Sets the value of {@link IntegrationGrantProps#getOperationId}
* @param operationId The ID of the operation for which permissions are being granted. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder operationId(java.lang.String operationId) {
this.operationId = operationId;
return this;
}
/**
* Sets the value of {@link IntegrationGrantProps#getScope}
* @param scope The scope in which permission resources can be created. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder scope(software.constructs.Construct scope) {
this.scope = scope;
return this;
}
/**
* Sets the value of {@link IntegrationGrantProps#getMethod}
* @param method The http method of this operation. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder method(java.lang.String method) {
this.method = method;
return this;
}
/**
* Sets the value of {@link IntegrationGrantProps#getPath}
* @param path The path of this operation in the api. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder path(java.lang.String path) {
this.path = path;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link IntegrationGrantProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public IntegrationGrantProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link IntegrationGrantProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements IntegrationGrantProps {
private final software.amazon.awscdk.services.apigateway.SpecRestApi api;
private final java.lang.String operationId;
private final software.constructs.Construct scope;
private final java.lang.String method;
private final java.lang.String path;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.api = software.amazon.jsii.Kernel.get(this, "api", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.apigateway.SpecRestApi.class));
this.operationId = software.amazon.jsii.Kernel.get(this, "operationId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.scope = software.amazon.jsii.Kernel.get(this, "scope", software.amazon.jsii.NativeType.forClass(software.constructs.Construct.class));
this.method = software.amazon.jsii.Kernel.get(this, "method", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.path = software.amazon.jsii.Kernel.get(this, "path", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.api = java.util.Objects.requireNonNull(builder.api, "api is required");
this.operationId = java.util.Objects.requireNonNull(builder.operationId, "operationId is required");
this.scope = java.util.Objects.requireNonNull(builder.scope, "scope is required");
this.method = java.util.Objects.requireNonNull(builder.method, "method is required");
this.path = java.util.Objects.requireNonNull(builder.path, "path is required");
}
@Override
public final software.amazon.awscdk.services.apigateway.SpecRestApi getApi() {
return this.api;
}
@Override
public final java.lang.String getOperationId() {
return this.operationId;
}
@Override
public final software.constructs.Construct getScope() {
return this.scope;
}
@Override
public final java.lang.String getMethod() {
return this.method;
}
@Override
public final java.lang.String getPath() {
return this.path;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("api", om.valueToTree(this.getApi()));
data.set("operationId", om.valueToTree(this.getOperationId()));
data.set("scope", om.valueToTree(this.getScope()));
data.set("method", om.valueToTree(this.getMethod()));
data.set("path", om.valueToTree(this.getPath()));
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-prototyping-sdk/open-api-gateway.IntegrationGrantProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
IntegrationGrantProps.Jsii$Proxy that = (IntegrationGrantProps.Jsii$Proxy) o;
if (!api.equals(that.api)) return false;
if (!operationId.equals(that.operationId)) return false;
if (!scope.equals(that.scope)) return false;
if (!method.equals(that.method)) return false;
return this.path.equals(that.path);
}
@Override
public final int hashCode() {
int result = this.api.hashCode();
result = 31 * result + (this.operationId.hashCode());
result = 31 * result + (this.scope.hashCode());
result = 31 * result + (this.method.hashCode());
result = 31 * result + (this.path.hashCode());
return result;
}
}
}