com.pulumi.azure.apimanagement.outputs.GetApiResult Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** 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.azure.apimanagement.outputs;
import com.pulumi.azure.apimanagement.outputs.GetApiSubscriptionKeyParameterName;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Objects;
@CustomType
public final class GetApiResult {
private String apiManagementName;
/**
* @return A description of the API Management API, which may include HTML formatting tags.
*
*/
private String description;
/**
* @return The display name of the API.
*
*/
private String displayName;
/**
* @return The provider-assigned unique ID for this managed resource.
*
*/
private String id;
/**
* @return Is this the current API Revision?
*
*/
private Boolean isCurrent;
/**
* @return Is this API Revision online/accessible via the Gateway?
*
*/
private Boolean isOnline;
private String name;
/**
* @return The Path for this API Management API.
*
*/
private String path;
/**
* @return A list of protocols the operations in this API can be invoked.
*
*/
private List protocols;
private String resourceGroupName;
private String revision;
/**
* @return Absolute URL of the backend service implementing this API.
*
*/
private String serviceUrl;
/**
* @return Should this API expose a SOAP frontend, rather than a HTTP frontend?
*
*/
private Boolean soapPassThrough;
/**
* @return A `subscription_key_parameter_names` block as documented below.
*
*/
private List subscriptionKeyParameterNames;
/**
* @return Should this API require a subscription key?
*
*/
private Boolean subscriptionRequired;
/**
* @return The Version number of this API, if this API is versioned.
*
*/
private String version;
/**
* @return The ID of the Version Set which this API is associated with.
*
*/
private String versionSetId;
private GetApiResult() {}
public String apiManagementName() {
return this.apiManagementName;
}
/**
* @return A description of the API Management API, which may include HTML formatting tags.
*
*/
public String description() {
return this.description;
}
/**
* @return The display name of the API.
*
*/
public String displayName() {
return this.displayName;
}
/**
* @return The provider-assigned unique ID for this managed resource.
*
*/
public String id() {
return this.id;
}
/**
* @return Is this the current API Revision?
*
*/
public Boolean isCurrent() {
return this.isCurrent;
}
/**
* @return Is this API Revision online/accessible via the Gateway?
*
*/
public Boolean isOnline() {
return this.isOnline;
}
public String name() {
return this.name;
}
/**
* @return The Path for this API Management API.
*
*/
public String path() {
return this.path;
}
/**
* @return A list of protocols the operations in this API can be invoked.
*
*/
public List protocols() {
return this.protocols;
}
public String resourceGroupName() {
return this.resourceGroupName;
}
public String revision() {
return this.revision;
}
/**
* @return Absolute URL of the backend service implementing this API.
*
*/
public String serviceUrl() {
return this.serviceUrl;
}
/**
* @return Should this API expose a SOAP frontend, rather than a HTTP frontend?
*
*/
public Boolean soapPassThrough() {
return this.soapPassThrough;
}
/**
* @return A `subscription_key_parameter_names` block as documented below.
*
*/
public List subscriptionKeyParameterNames() {
return this.subscriptionKeyParameterNames;
}
/**
* @return Should this API require a subscription key?
*
*/
public Boolean subscriptionRequired() {
return this.subscriptionRequired;
}
/**
* @return The Version number of this API, if this API is versioned.
*
*/
public String version() {
return this.version;
}
/**
* @return The ID of the Version Set which this API is associated with.
*
*/
public String versionSetId() {
return this.versionSetId;
}
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 String apiManagementName;
private String description;
private String displayName;
private String id;
private Boolean isCurrent;
private Boolean isOnline;
private String name;
private String path;
private List protocols;
private String resourceGroupName;
private String revision;
private String serviceUrl;
private Boolean soapPassThrough;
private List subscriptionKeyParameterNames;
private Boolean subscriptionRequired;
private String version;
private String versionSetId;
public Builder() {}
public Builder(GetApiResult defaults) {
Objects.requireNonNull(defaults);
this.apiManagementName = defaults.apiManagementName;
this.description = defaults.description;
this.displayName = defaults.displayName;
this.id = defaults.id;
this.isCurrent = defaults.isCurrent;
this.isOnline = defaults.isOnline;
this.name = defaults.name;
this.path = defaults.path;
this.protocols = defaults.protocols;
this.resourceGroupName = defaults.resourceGroupName;
this.revision = defaults.revision;
this.serviceUrl = defaults.serviceUrl;
this.soapPassThrough = defaults.soapPassThrough;
this.subscriptionKeyParameterNames = defaults.subscriptionKeyParameterNames;
this.subscriptionRequired = defaults.subscriptionRequired;
this.version = defaults.version;
this.versionSetId = defaults.versionSetId;
}
@CustomType.Setter
public Builder apiManagementName(String apiManagementName) {
if (apiManagementName == null) {
throw new MissingRequiredPropertyException("GetApiResult", "apiManagementName");
}
this.apiManagementName = apiManagementName;
return this;
}
@CustomType.Setter
public Builder description(String description) {
if (description == null) {
throw new MissingRequiredPropertyException("GetApiResult", "description");
}
this.description = description;
return this;
}
@CustomType.Setter
public Builder displayName(String displayName) {
if (displayName == null) {
throw new MissingRequiredPropertyException("GetApiResult", "displayName");
}
this.displayName = displayName;
return this;
}
@CustomType.Setter
public Builder id(String id) {
if (id == null) {
throw new MissingRequiredPropertyException("GetApiResult", "id");
}
this.id = id;
return this;
}
@CustomType.Setter
public Builder isCurrent(Boolean isCurrent) {
if (isCurrent == null) {
throw new MissingRequiredPropertyException("GetApiResult", "isCurrent");
}
this.isCurrent = isCurrent;
return this;
}
@CustomType.Setter
public Builder isOnline(Boolean isOnline) {
if (isOnline == null) {
throw new MissingRequiredPropertyException("GetApiResult", "isOnline");
}
this.isOnline = isOnline;
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 path(String path) {
if (path == null) {
throw new MissingRequiredPropertyException("GetApiResult", "path");
}
this.path = path;
return this;
}
@CustomType.Setter
public Builder protocols(List protocols) {
if (protocols == null) {
throw new MissingRequiredPropertyException("GetApiResult", "protocols");
}
this.protocols = protocols;
return this;
}
public Builder protocols(String... protocols) {
return protocols(List.of(protocols));
}
@CustomType.Setter
public Builder resourceGroupName(String resourceGroupName) {
if (resourceGroupName == null) {
throw new MissingRequiredPropertyException("GetApiResult", "resourceGroupName");
}
this.resourceGroupName = resourceGroupName;
return this;
}
@CustomType.Setter
public Builder revision(String revision) {
if (revision == null) {
throw new MissingRequiredPropertyException("GetApiResult", "revision");
}
this.revision = revision;
return this;
}
@CustomType.Setter
public Builder serviceUrl(String serviceUrl) {
if (serviceUrl == null) {
throw new MissingRequiredPropertyException("GetApiResult", "serviceUrl");
}
this.serviceUrl = serviceUrl;
return this;
}
@CustomType.Setter
public Builder soapPassThrough(Boolean soapPassThrough) {
if (soapPassThrough == null) {
throw new MissingRequiredPropertyException("GetApiResult", "soapPassThrough");
}
this.soapPassThrough = soapPassThrough;
return this;
}
@CustomType.Setter
public Builder subscriptionKeyParameterNames(List subscriptionKeyParameterNames) {
if (subscriptionKeyParameterNames == null) {
throw new MissingRequiredPropertyException("GetApiResult", "subscriptionKeyParameterNames");
}
this.subscriptionKeyParameterNames = subscriptionKeyParameterNames;
return this;
}
public Builder subscriptionKeyParameterNames(GetApiSubscriptionKeyParameterName... subscriptionKeyParameterNames) {
return subscriptionKeyParameterNames(List.of(subscriptionKeyParameterNames));
}
@CustomType.Setter
public Builder subscriptionRequired(Boolean subscriptionRequired) {
if (subscriptionRequired == null) {
throw new MissingRequiredPropertyException("GetApiResult", "subscriptionRequired");
}
this.subscriptionRequired = subscriptionRequired;
return this;
}
@CustomType.Setter
public Builder version(String version) {
if (version == null) {
throw new MissingRequiredPropertyException("GetApiResult", "version");
}
this.version = version;
return this;
}
@CustomType.Setter
public Builder versionSetId(String versionSetId) {
if (versionSetId == null) {
throw new MissingRequiredPropertyException("GetApiResult", "versionSetId");
}
this.versionSetId = versionSetId;
return this;
}
public GetApiResult build() {
final var _resultValue = new GetApiResult();
_resultValue.apiManagementName = apiManagementName;
_resultValue.description = description;
_resultValue.displayName = displayName;
_resultValue.id = id;
_resultValue.isCurrent = isCurrent;
_resultValue.isOnline = isOnline;
_resultValue.name = name;
_resultValue.path = path;
_resultValue.protocols = protocols;
_resultValue.resourceGroupName = resourceGroupName;
_resultValue.revision = revision;
_resultValue.serviceUrl = serviceUrl;
_resultValue.soapPassThrough = soapPassThrough;
_resultValue.subscriptionKeyParameterNames = subscriptionKeyParameterNames;
_resultValue.subscriptionRequired = subscriptionRequired;
_resultValue.version = version;
_resultValue.versionSetId = versionSetId;
return _resultValue;
}
}
}