All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azurenative.apicenter.outputs.GetApiResult Maven / Gradle / Ivy

There is a newer version: 2.78.0
Show newest version
// *** 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.apicenter.outputs;

import com.pulumi.azurenative.apicenter.outputs.ContactResponse;
import com.pulumi.azurenative.apicenter.outputs.ExternalDocumentationResponse;
import com.pulumi.azurenative.apicenter.outputs.LicenseResponse;
import com.pulumi.azurenative.apicenter.outputs.SystemDataResponse;
import com.pulumi.azurenative.apicenter.outputs.TermsOfServiceResponse;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Object;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;

@CustomType
public final class GetApiResult {
    /**
     * @return The set of contacts
     * 
     */
    private @Nullable List contacts;
    /**
     * @return The custom metadata defined for API catalog entities.
     * 
     */
    private @Nullable Object customProperties;
    /**
     * @return Description of the API.
     * 
     */
    private @Nullable String description;
    /**
     * @return The set of external documentation
     * 
     */
    private @Nullable List externalDocumentation;
    /**
     * @return Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
     * 
     */
    private String id;
    /**
     * @return Kind of API. For example, REST or GraphQL.
     * 
     */
    private String kind;
    /**
     * @return The license information for the API.
     * 
     */
    private @Nullable LicenseResponse license;
    /**
     * @return Current lifecycle stage of the API.
     * 
     */
    private String lifecycleStage;
    /**
     * @return The name of the resource
     * 
     */
    private String name;
    /**
     * @return Short description of the API.
     * 
     */
    private @Nullable String summary;
    /**
     * @return Azure Resource Manager metadata containing createdBy and modifiedBy information.
     * 
     */
    private SystemDataResponse systemData;
    /**
     * @return Terms of service for the API.
     * 
     */
    private @Nullable TermsOfServiceResponse termsOfService;
    /**
     * @return API title.
     * 
     */
    private String title;
    /**
     * @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     * 
     */
    private String type;

    private GetApiResult() {}
    /**
     * @return The set of contacts
     * 
     */
    public List contacts() {
        return this.contacts == null ? List.of() : this.contacts;
    }
    /**
     * @return The custom metadata defined for API catalog entities.
     * 
     */
    public Optional customProperties() {
        return Optional.ofNullable(this.customProperties);
    }
    /**
     * @return Description of the API.
     * 
     */
    public Optional description() {
        return Optional.ofNullable(this.description);
    }
    /**
     * @return The set of external documentation
     * 
     */
    public List externalDocumentation() {
        return this.externalDocumentation == null ? List.of() : this.externalDocumentation;
    }
    /**
     * @return Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
     * 
     */
    public String id() {
        return this.id;
    }
    /**
     * @return Kind of API. For example, REST or GraphQL.
     * 
     */
    public String kind() {
        return this.kind;
    }
    /**
     * @return The license information for the API.
     * 
     */
    public Optional license() {
        return Optional.ofNullable(this.license);
    }
    /**
     * @return Current lifecycle stage of the API.
     * 
     */
    public String lifecycleStage() {
        return this.lifecycleStage;
    }
    /**
     * @return The name of the resource
     * 
     */
    public String name() {
        return this.name;
    }
    /**
     * @return Short description of the API.
     * 
     */
    public Optional summary() {
        return Optional.ofNullable(this.summary);
    }
    /**
     * @return Azure Resource Manager metadata containing createdBy and modifiedBy information.
     * 
     */
    public SystemDataResponse systemData() {
        return this.systemData;
    }
    /**
     * @return Terms of service for the API.
     * 
     */
    public Optional termsOfService() {
        return Optional.ofNullable(this.termsOfService);
    }
    /**
     * @return API title.
     * 
     */
    public String title() {
        return this.title;
    }
    /**
     * @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     * 
     */
    public String type() {
        return this.type;
    }

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

    public static Builder builder(GetApiResult defaults) {
        return new Builder(defaults);
    }
    @CustomType.Builder
    public static final class Builder {
        private @Nullable List contacts;
        private @Nullable Object customProperties;
        private @Nullable String description;
        private @Nullable List externalDocumentation;
        private String id;
        private String kind;
        private @Nullable LicenseResponse license;
        private String lifecycleStage;
        private String name;
        private @Nullable String summary;
        private SystemDataResponse systemData;
        private @Nullable TermsOfServiceResponse termsOfService;
        private String title;
        private String type;
        public Builder() {}
        public Builder(GetApiResult defaults) {
    	      Objects.requireNonNull(defaults);
    	      this.contacts = defaults.contacts;
    	      this.customProperties = defaults.customProperties;
    	      this.description = defaults.description;
    	      this.externalDocumentation = defaults.externalDocumentation;
    	      this.id = defaults.id;
    	      this.kind = defaults.kind;
    	      this.license = defaults.license;
    	      this.lifecycleStage = defaults.lifecycleStage;
    	      this.name = defaults.name;
    	      this.summary = defaults.summary;
    	      this.systemData = defaults.systemData;
    	      this.termsOfService = defaults.termsOfService;
    	      this.title = defaults.title;
    	      this.type = defaults.type;
        }

        @CustomType.Setter
        public Builder contacts(@Nullable List contacts) {

            this.contacts = contacts;
            return this;
        }
        public Builder contacts(ContactResponse... contacts) {
            return contacts(List.of(contacts));
        }
        @CustomType.Setter
        public Builder customProperties(@Nullable Object customProperties) {

            this.customProperties = customProperties;
            return this;
        }
        @CustomType.Setter
        public Builder description(@Nullable String description) {

            this.description = description;
            return this;
        }
        @CustomType.Setter
        public Builder externalDocumentation(@Nullable List externalDocumentation) {

            this.externalDocumentation = externalDocumentation;
            return this;
        }
        public Builder externalDocumentation(ExternalDocumentationResponse... externalDocumentation) {
            return externalDocumentation(List.of(externalDocumentation));
        }
        @CustomType.Setter
        public Builder id(String id) {
            if (id == null) {
              throw new MissingRequiredPropertyException("GetApiResult", "id");
            }
            this.id = id;
            return this;
        }
        @CustomType.Setter
        public Builder kind(String kind) {
            if (kind == null) {
              throw new MissingRequiredPropertyException("GetApiResult", "kind");
            }
            this.kind = kind;
            return this;
        }
        @CustomType.Setter
        public Builder license(@Nullable LicenseResponse license) {

            this.license = license;
            return this;
        }
        @CustomType.Setter
        public Builder lifecycleStage(String lifecycleStage) {
            if (lifecycleStage == null) {
              throw new MissingRequiredPropertyException("GetApiResult", "lifecycleStage");
            }
            this.lifecycleStage = lifecycleStage;
            return this;
        }
        @CustomType.Setter
        public Builder name(String name) {
            if (name == null) {
              throw new MissingRequiredPropertyException("GetApiResult", "name");
            }
            this.name = name;
            return this;
        }
        @CustomType.Setter
        public Builder summary(@Nullable String summary) {

            this.summary = summary;
            return this;
        }
        @CustomType.Setter
        public Builder systemData(SystemDataResponse systemData) {
            if (systemData == null) {
              throw new MissingRequiredPropertyException("GetApiResult", "systemData");
            }
            this.systemData = systemData;
            return this;
        }
        @CustomType.Setter
        public Builder termsOfService(@Nullable TermsOfServiceResponse termsOfService) {

            this.termsOfService = termsOfService;
            return this;
        }
        @CustomType.Setter
        public Builder title(String title) {
            if (title == null) {
              throw new MissingRequiredPropertyException("GetApiResult", "title");
            }
            this.title = title;
            return this;
        }
        @CustomType.Setter
        public Builder type(String type) {
            if (type == null) {
              throw new MissingRequiredPropertyException("GetApiResult", "type");
            }
            this.type = type;
            return this;
        }
        public GetApiResult build() {
            final var _resultValue = new GetApiResult();
            _resultValue.contacts = contacts;
            _resultValue.customProperties = customProperties;
            _resultValue.description = description;
            _resultValue.externalDocumentation = externalDocumentation;
            _resultValue.id = id;
            _resultValue.kind = kind;
            _resultValue.license = license;
            _resultValue.lifecycleStage = lifecycleStage;
            _resultValue.name = name;
            _resultValue.summary = summary;
            _resultValue.systemData = systemData;
            _resultValue.termsOfService = termsOfService;
            _resultValue.title = title;
            _resultValue.type = type;
            return _resultValue;
        }
    }
}