com.pulumi.azurenative.deviceregistry.inputs.DataPointArgs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
There is a newer version: 2.82.0
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.azurenative.deviceregistry.inputs;

import com.pulumi.azurenative.deviceregistry.enums.DataPointsObservabilityMode;
import com.pulumi.core.Either;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.core.internal.Codegen;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


/**
 * Defines the data point properties.
 * 
 */
public final class DataPointArgs extends com.pulumi.resources.ResourceArgs {

    public static final DataPointArgs Empty = new DataPointArgs();

    /**
     * The path to the type definition of the capability (e.g. DTMI, OPC UA information model node id, etc.), for example dtmi:com:example:Robot:_contents:__prop1;1.
     * 
     */
    @Import(name="capabilityId")
    private @Nullable Output capabilityId;

    /**
     * @return The path to the type definition of the capability (e.g. DTMI, OPC UA information model node id, etc.), for example dtmi:com:example:Robot:_contents:__prop1;1.
     * 
     */
    public Optional> capabilityId() {
        return Optional.ofNullable(this.capabilityId);
    }

    /**
     * Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.
     * 
     */
    @Import(name="dataPointConfiguration")
    private @Nullable Output dataPointConfiguration;

    /**
     * @return Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.
     * 
     */
    public Optional> dataPointConfiguration() {
        return Optional.ofNullable(this.dataPointConfiguration);
    }

    /**
     * The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset.
     * 
     */
    @Import(name="dataSource", required=true)
    private Output dataSource;

    /**
     * @return The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset.
     * 
     */
    public Output dataSource() {
        return this.dataSource;
    }

    /**
     * The name of the data point.
     * 
     */
    @Import(name="name")
    private @Nullable Output name;

    /**
     * @return The name of the data point.
     * 
     */
    public Optional> name() {
        return Optional.ofNullable(this.name);
    }

    /**
     * An indication of how the data point should be mapped to OpenTelemetry.
     * 
     */
    @Import(name="observabilityMode")
    private @Nullable Output> observabilityMode;

    /**
     * @return An indication of how the data point should be mapped to OpenTelemetry.
     * 
     */
    public Optional>> observabilityMode() {
        return Optional.ofNullable(this.observabilityMode);
    }

    private DataPointArgs() {}

    private DataPointArgs(DataPointArgs $) {
        this.capabilityId = $.capabilityId;
        this.dataPointConfiguration = $.dataPointConfiguration;
        this.dataSource = $.dataSource;
        this.name = $.name;
        this.observabilityMode = $.observabilityMode;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(DataPointArgs defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private DataPointArgs $;

        public Builder() {
            $ = new DataPointArgs();
        }

        public Builder(DataPointArgs defaults) {
            $ = new DataPointArgs(Objects.requireNonNull(defaults));
        }

        /**
         * @param capabilityId The path to the type definition of the capability (e.g. DTMI, OPC UA information model node id, etc.), for example dtmi:com:example:Robot:_contents:__prop1;1.
         * 
         * @return builder
         * 
         */
        public Builder capabilityId(@Nullable Output capabilityId) {
            $.capabilityId = capabilityId;
            return this;
        }

        /**
         * @param capabilityId The path to the type definition of the capability (e.g. DTMI, OPC UA information model node id, etc.), for example dtmi:com:example:Robot:_contents:__prop1;1.
         * 
         * @return builder
         * 
         */
        public Builder capabilityId(String capabilityId) {
            return capabilityId(Output.of(capabilityId));
        }

        /**
         * @param dataPointConfiguration Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.
         * 
         * @return builder
         * 
         */
        public Builder dataPointConfiguration(@Nullable Output dataPointConfiguration) {
            $.dataPointConfiguration = dataPointConfiguration;
            return this;
        }

        /**
         * @param dataPointConfiguration Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.
         * 
         * @return builder
         * 
         */
        public Builder dataPointConfiguration(String dataPointConfiguration) {
            return dataPointConfiguration(Output.of(dataPointConfiguration));
        }

        /**
         * @param dataSource The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset.
         * 
         * @return builder
         * 
         */
        public Builder dataSource(Output dataSource) {
            $.dataSource = dataSource;
            return this;
        }

        /**
         * @param dataSource The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset.
         * 
         * @return builder
         * 
         */
        public Builder dataSource(String dataSource) {
            return dataSource(Output.of(dataSource));
        }

        /**
         * @param name The name of the data point.
         * 
         * @return builder
         * 
         */
        public Builder name(@Nullable Output name) {
            $.name = name;
            return this;
        }

        /**
         * @param name The name of the data point.
         * 
         * @return builder
         * 
         */
        public Builder name(String name) {
            return name(Output.of(name));
        }

        /**
         * @param observabilityMode An indication of how the data point should be mapped to OpenTelemetry.
         * 
         * @return builder
         * 
         */
        public Builder observabilityMode(@Nullable Output> observabilityMode) {
            $.observabilityMode = observabilityMode;
            return this;
        }

        /**
         * @param observabilityMode An indication of how the data point should be mapped to OpenTelemetry.
         * 
         * @return builder
         * 
         */
        public Builder observabilityMode(Either observabilityMode) {
            return observabilityMode(Output.of(observabilityMode));
        }

        /**
         * @param observabilityMode An indication of how the data point should be mapped to OpenTelemetry.
         * 
         * @return builder
         * 
         */
        public Builder observabilityMode(String observabilityMode) {
            return observabilityMode(Either.ofLeft(observabilityMode));
        }

        /**
         * @param observabilityMode An indication of how the data point should be mapped to OpenTelemetry.
         * 
         * @return builder
         * 
         */
        public Builder observabilityMode(DataPointsObservabilityMode observabilityMode) {
            return observabilityMode(Either.ofRight(observabilityMode));
        }

        public DataPointArgs build() {
            if ($.dataSource == null) {
                throw new MissingRequiredPropertyException("DataPointArgs", "dataSource");
            }
            $.observabilityMode = Codegen.stringProp("observabilityMode").left(DataPointsObservabilityMode.class).output().arg($.observabilityMode).def("none").getNullable();
            return $;
        }
    }

}