com.aliyun.ros.cdk.sls.Index Maven / Gradle / Ivy
Show all versions of ros-cdk-sls Show documentation
package com.aliyun.ros.cdk.sls;
/**
* This class encapsulates and extends the ROS resource type ALIYUN::SLS::Index
, which is used to create an index for a specified Logstore.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.85.0 (build 08ee592)", date = "2024-09-29T07:52:42.704Z")
@software.amazon.jsii.Jsii(module = com.aliyun.ros.cdk.sls.$Module.class, fqn = "@alicloud/ros-cdk-sls.Index")
public class Index extends com.aliyun.ros.cdk.core.Resource {
protected Index(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected Index(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
* @param enableResourcePropertyConstraint
*/
public Index(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.sls.IndexProps props, final @org.jetbrains.annotations.Nullable java.lang.Boolean enableResourcePropertyConstraint) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required"), enableResourcePropertyConstraint });
}
/**
* Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
*/
public Index(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.sls.IndexProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
protected @org.jetbrains.annotations.NotNull java.lang.Boolean getEnableResourcePropertyConstraint() {
return software.amazon.jsii.Kernel.get(this, "enableResourcePropertyConstraint", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
protected void setEnableResourcePropertyConstraint(final @org.jetbrains.annotations.NotNull java.lang.Boolean value) {
software.amazon.jsii.Kernel.set(this, "enableResourcePropertyConstraint", java.util.Objects.requireNonNull(value, "enableResourcePropertyConstraint is required"));
}
protected @org.jetbrains.annotations.NotNull java.lang.String getId() {
return software.amazon.jsii.Kernel.get(this, "id", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
protected void setId(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "id", java.util.Objects.requireNonNull(value, "id is required"));
}
protected @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.sls.IndexProps getProps() {
return software.amazon.jsii.Kernel.get(this, "props", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.sls.IndexProps.class));
}
protected void setProps(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.sls.IndexProps value) {
software.amazon.jsii.Kernel.set(this, "props", java.util.Objects.requireNonNull(value, "props is required"));
}
protected @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct getScope() {
return software.amazon.jsii.Kernel.get(this, "scope", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.Construct.class));
}
protected void setScope(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct value) {
software.amazon.jsii.Kernel.set(this, "scope", java.util.Objects.requireNonNull(value, "scope is required"));
}
/**
* A fluent builder for {@link com.aliyun.ros.cdk.sls.Index}.
*/
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
* @param enableResourcePropertyConstraint
*/
public static Builder create(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id, final java.lang.Boolean enableResourcePropertyConstraint) {
return new Builder(scope, id, enableResourcePropertyConstraint);
}
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
*/
public static Builder create(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id) {
return new Builder(scope, id, null);
}
private final com.aliyun.ros.cdk.core.Construct scope;
private final java.lang.String id;
private final java.lang.Boolean enableResourcePropertyConstraint;
private final com.aliyun.ros.cdk.sls.IndexProps.Builder props;
private Builder(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id, final java.lang.Boolean enableResourcePropertyConstraint) {
this.scope = scope;
this.id = id;
this.enableResourcePropertyConstraint = enableResourcePropertyConstraint;
this.props = new com.aliyun.ros.cdk.sls.IndexProps.Builder();
}
/**
* Property fullTextIndex: Full-text indexing configuration.
*
* Full-text indexing and key indexing must have at least one enabled.
*
* @return {@code this}
* @param fullTextIndex Property fullTextIndex: Full-text indexing configuration. This parameter is required.
*/
public Builder fullTextIndex(final com.aliyun.ros.cdk.core.IResolvable fullTextIndex) {
this.props.fullTextIndex(fullTextIndex);
return this;
}
/**
* Property fullTextIndex: Full-text indexing configuration.
*
* Full-text indexing and key indexing must have at least one enabled.
*
* @return {@code this}
* @param fullTextIndex Property fullTextIndex: Full-text indexing configuration. This parameter is required.
*/
public Builder fullTextIndex(final com.aliyun.ros.cdk.sls.RosIndex.FullTextIndexProperty fullTextIndex) {
this.props.fullTextIndex(fullTextIndex);
return this;
}
/**
* Property logstoreName: Logstore name: 1.
*
* Only supports lowercase letters, numbers, hyphens (-) and underscores (_).
* 2. Must start and end with lowercase letters and numbers.
* 3. The name length is 3-63 characters.
*
* @return {@code this}
* @param logstoreName Property logstoreName: Logstore name: 1. This parameter is required.
*/
public Builder logstoreName(final java.lang.String logstoreName) {
this.props.logstoreName(logstoreName);
return this;
}
/**
* Property logstoreName: Logstore name: 1.
*
* Only supports lowercase letters, numbers, hyphens (-) and underscores (_).
* 2. Must start and end with lowercase letters and numbers.
* 3. The name length is 3-63 characters.
*
* @return {@code this}
* @param logstoreName Property logstoreName: Logstore name: 1. This parameter is required.
*/
public Builder logstoreName(final com.aliyun.ros.cdk.core.IResolvable logstoreName) {
this.props.logstoreName(logstoreName);
return this;
}
/**
* Property projectName: Project name: 1.
*
* Only supports lowercase letters, numbers, hyphens (-) and underscores (_).
* 2. Must start and end with lowercase letters and numbers.
* 3. The name length is 3-63 characters.
*
* @return {@code this}
* @param projectName Property projectName: Project name: 1. This parameter is required.
*/
public Builder projectName(final java.lang.String projectName) {
this.props.projectName(projectName);
return this;
}
/**
* Property projectName: Project name: 1.
*
* Only supports lowercase letters, numbers, hyphens (-) and underscores (_).
* 2. Must start and end with lowercase letters and numbers.
* 3. The name length is 3-63 characters.
*
* @return {@code this}
* @param projectName Property projectName: Project name: 1. This parameter is required.
*/
public Builder projectName(final com.aliyun.ros.cdk.core.IResolvable projectName) {
this.props.projectName(projectName);
return this;
}
/**
* Property keyIndices: Key index configurations.
*
* Full-text indexing and key indexing must have at least one enabled.
*
* @return {@code this}
* @param keyIndices Property keyIndices: Key index configurations. This parameter is required.
*/
public Builder keyIndices(final com.aliyun.ros.cdk.core.IResolvable keyIndices) {
this.props.keyIndices(keyIndices);
return this;
}
/**
* Property keyIndices: Key index configurations.
*
* Full-text indexing and key indexing must have at least one enabled.
*
* @return {@code this}
* @param keyIndices Property keyIndices: Key index configurations. This parameter is required.
*/
public Builder keyIndices(final java.util.List extends java.lang.Object> keyIndices) {
this.props.keyIndices(keyIndices);
return this;
}
/**
* Property logReduce: Whether to enable log reduce.
*
* Default to false.
*
* @return {@code this}
* @param logReduce Property logReduce: Whether to enable log reduce. This parameter is required.
*/
public Builder logReduce(final java.lang.Boolean logReduce) {
this.props.logReduce(logReduce);
return this;
}
/**
* Property logReduce: Whether to enable log reduce.
*
* Default to false.
*
* @return {@code this}
* @param logReduce Property logReduce: Whether to enable log reduce. This parameter is required.
*/
public Builder logReduce(final com.aliyun.ros.cdk.core.IResolvable logReduce) {
this.props.logReduce(logReduce);
return this;
}
/**
* @return a newly built instance of {@link com.aliyun.ros.cdk.sls.Index}.
*/
@Override
public com.aliyun.ros.cdk.sls.Index build() {
return new com.aliyun.ros.cdk.sls.Index(
this.scope,
this.id,
this.props.build(),
this.enableResourcePropertyConstraint
);
}
}
}