io.github.cdklabs.awscdk.appsync.utils.IField Maven / Gradle / Ivy
Show all versions of awscdk-appsync-utils Show documentation
package io.github.cdklabs.awscdk.appsync.utils;
/**
* A Graphql Field.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-28T00:18:00.302Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.awscdk.appsync.utils.$Module.class, fqn = "awscdk-appsync-utils.IField")
@software.amazon.jsii.Jsii.Proxy(IField.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface IField extends software.amazon.jsii.JsiiSerializable {
/**
* property determining if this attribute is a list i.e. if true, attribute would be [Type].
*
* Default: false
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.Boolean getIsList();
/**
* property determining if this attribute is non-nullable i.e. if true, attribute would be Type! and this attribute must always have a value.
*
* Default: false
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.Boolean getIsRequired();
/**
* property determining if this attribute is a non-nullable list i.e. if true, attribute would be [ Type ]! and this attribute's list must always have a value.
*
* Default: false
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.Boolean getIsRequiredList();
/**
* the type of attribute.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull io.github.cdklabs.awscdk.appsync.utils.Type getType();
/**
* The options to make this field resolvable.
*
* Default: - not a resolvable field
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable io.github.cdklabs.awscdk.appsync.utils.ResolvableFieldOptions getFieldOptions() {
return null;
}
/**
* the intermediate type linked to this attribute (i.e. an interface or an object).
*
* Default: - no intermediate type
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable io.github.cdklabs.awscdk.appsync.utils.IIntermediateType getIntermediateType() {
return null;
}
/**
* Generate the arguments for this field.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String argsToString();
/**
* Generate the directives for this field.
*
* Default: - no authorization modes
*
* @param modes the authorization modes of the graphql api.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String directivesToString(final @org.jetbrains.annotations.Nullable java.util.List modes);
/**
* Generate the directives for this field.
*
* Default: - no authorization modes
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String directivesToString();
/**
* Generate the string for this attribute.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String toString();
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements io.github.cdklabs.awscdk.appsync.utils.IField.Jsii$Default {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
/**
* property determining if this attribute is a list i.e. if true, attribute would be [Type].
*
* Default: false
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull java.lang.Boolean getIsList() {
return software.amazon.jsii.Kernel.get(this, "isList", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* property determining if this attribute is non-nullable i.e. if true, attribute would be Type! and this attribute must always have a value.
*
* Default: false
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull java.lang.Boolean getIsRequired() {
return software.amazon.jsii.Kernel.get(this, "isRequired", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* property determining if this attribute is a non-nullable list i.e. if true, attribute would be [ Type ]! and this attribute's list must always have a value.
*
* Default: false
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull java.lang.Boolean getIsRequiredList() {
return software.amazon.jsii.Kernel.get(this, "isRequiredList", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* the type of attribute.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull io.github.cdklabs.awscdk.appsync.utils.Type getType() {
return software.amazon.jsii.Kernel.get(this, "type", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.awscdk.appsync.utils.Type.class));
}
/**
* The options to make this field resolvable.
*
* Default: - not a resolvable field
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.Nullable io.github.cdklabs.awscdk.appsync.utils.ResolvableFieldOptions getFieldOptions() {
return software.amazon.jsii.Kernel.get(this, "fieldOptions", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.awscdk.appsync.utils.ResolvableFieldOptions.class));
}
/**
* the intermediate type linked to this attribute (i.e. an interface or an object).
*
* Default: - no intermediate type
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.Nullable io.github.cdklabs.awscdk.appsync.utils.IIntermediateType getIntermediateType() {
return software.amazon.jsii.Kernel.get(this, "intermediateType", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.awscdk.appsync.utils.IIntermediateType.class));
}
/**
* Generate the arguments for this field.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public final @org.jetbrains.annotations.NotNull java.lang.String argsToString() {
return software.amazon.jsii.Kernel.call(this, "argsToString", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Generate the directives for this field.
*
* Default: - no authorization modes
*
* @param modes the authorization modes of the graphql api.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public final @org.jetbrains.annotations.NotNull java.lang.String directivesToString(final @org.jetbrains.annotations.Nullable java.util.List modes) {
return software.amazon.jsii.Kernel.call(this, "directivesToString", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { modes });
}
/**
* Generate the directives for this field.
*
* Default: - no authorization modes
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public final @org.jetbrains.annotations.NotNull java.lang.String directivesToString() {
return software.amazon.jsii.Kernel.call(this, "directivesToString", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Generate the string for this attribute.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public final @org.jetbrains.annotations.NotNull java.lang.String toString() {
return software.amazon.jsii.Kernel.call(this, "toString", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
}
/**
* Internal default implementation for {@link IField}.
*/
@software.amazon.jsii.Internal
interface Jsii$Default extends IField {
/**
* property determining if this attribute is a list i.e. if true, attribute would be [Type].
*
* Default: false
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull java.lang.Boolean getIsList() {
return software.amazon.jsii.Kernel.get(this, "isList", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* property determining if this attribute is non-nullable i.e. if true, attribute would be Type! and this attribute must always have a value.
*
* Default: false
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull java.lang.Boolean getIsRequired() {
return software.amazon.jsii.Kernel.get(this, "isRequired", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* property determining if this attribute is a non-nullable list i.e. if true, attribute would be [ Type ]! and this attribute's list must always have a value.
*
* Default: false
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull java.lang.Boolean getIsRequiredList() {
return software.amazon.jsii.Kernel.get(this, "isRequiredList", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* the type of attribute.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull io.github.cdklabs.awscdk.appsync.utils.Type getType() {
return software.amazon.jsii.Kernel.get(this, "type", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.awscdk.appsync.utils.Type.class));
}
/**
* The options to make this field resolvable.
*
* Default: - not a resolvable field
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable io.github.cdklabs.awscdk.appsync.utils.ResolvableFieldOptions getFieldOptions() {
return software.amazon.jsii.Kernel.get(this, "fieldOptions", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.awscdk.appsync.utils.ResolvableFieldOptions.class));
}
/**
* the intermediate type linked to this attribute (i.e. an interface or an object).
*
* Default: - no intermediate type
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable io.github.cdklabs.awscdk.appsync.utils.IIntermediateType getIntermediateType() {
return software.amazon.jsii.Kernel.get(this, "intermediateType", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.awscdk.appsync.utils.IIntermediateType.class));
}
/**
* Generate the arguments for this field.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
default @org.jetbrains.annotations.NotNull java.lang.String argsToString() {
return software.amazon.jsii.Kernel.call(this, "argsToString", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Generate the directives for this field.
*
* Default: - no authorization modes
*
* @param modes the authorization modes of the graphql api.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
default @org.jetbrains.annotations.NotNull java.lang.String directivesToString(final @org.jetbrains.annotations.Nullable java.util.List modes) {
return software.amazon.jsii.Kernel.call(this, "directivesToString", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { modes });
}
}
}