com.pulumi.azurenative.apimanagement.outputs.GetApiGatewayResult 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
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** 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.apimanagement.outputs;
import com.pulumi.azurenative.apimanagement.outputs.ApiManagementGatewaySkuPropertiesResponse;
import com.pulumi.azurenative.apimanagement.outputs.BackendConfigurationResponse;
import com.pulumi.azurenative.apimanagement.outputs.FrontendConfigurationResponse;
import com.pulumi.azurenative.apimanagement.outputs.GatewayConfigurationApiResponse;
import com.pulumi.azurenative.apimanagement.outputs.SystemDataResponse;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
@CustomType
public final class GetApiGatewayResult {
/**
* @return Information regarding how the gateway should integrate with backend systems.
*
*/
private @Nullable BackendConfigurationResponse backend;
/**
* @return Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
*
*/
private @Nullable GatewayConfigurationApiResponse configurationApi;
/**
* @return Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
*
*/
private String createdAtUtc;
/**
* @return ETag of the resource.
*
*/
private String etag;
/**
* @return Information regarding how the gateway should be exposed.
*
*/
private @Nullable FrontendConfigurationResponse frontend;
/**
* @return Resource ID.
*
*/
private String id;
/**
* @return Resource location.
*
*/
private String location;
/**
* @return Resource name.
*
*/
private String name;
/**
* @return The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
*
*/
private String provisioningState;
/**
* @return SKU properties of the API Management gateway.
*
*/
private ApiManagementGatewaySkuPropertiesResponse sku;
/**
* @return Metadata pertaining to creation and last modification of the resource.
*
*/
private SystemDataResponse systemData;
/**
* @return Resource tags.
*
*/
private @Nullable Map tags;
/**
* @return The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
*
*/
private String targetProvisioningState;
/**
* @return Resource type for API Management resource is set to Microsoft.ApiManagement.
*
*/
private String type;
/**
* @return The type of VPN in which API Management gateway needs to be configured in.
*
*/
private @Nullable String virtualNetworkType;
private GetApiGatewayResult() {}
/**
* @return Information regarding how the gateway should integrate with backend systems.
*
*/
public Optional backend() {
return Optional.ofNullable(this.backend);
}
/**
* @return Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
*
*/
public Optional configurationApi() {
return Optional.ofNullable(this.configurationApi);
}
/**
* @return Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
*
*/
public String createdAtUtc() {
return this.createdAtUtc;
}
/**
* @return ETag of the resource.
*
*/
public String etag() {
return this.etag;
}
/**
* @return Information regarding how the gateway should be exposed.
*
*/
public Optional frontend() {
return Optional.ofNullable(this.frontend);
}
/**
* @return Resource ID.
*
*/
public String id() {
return this.id;
}
/**
* @return Resource location.
*
*/
public String location() {
return this.location;
}
/**
* @return Resource name.
*
*/
public String name() {
return this.name;
}
/**
* @return The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
*
*/
public String provisioningState() {
return this.provisioningState;
}
/**
* @return SKU properties of the API Management gateway.
*
*/
public ApiManagementGatewaySkuPropertiesResponse sku() {
return this.sku;
}
/**
* @return Metadata pertaining to creation and last modification of the resource.
*
*/
public SystemDataResponse systemData() {
return this.systemData;
}
/**
* @return Resource tags.
*
*/
public Map tags() {
return this.tags == null ? Map.of() : this.tags;
}
/**
* @return The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
*
*/
public String targetProvisioningState() {
return this.targetProvisioningState;
}
/**
* @return Resource type for API Management resource is set to Microsoft.ApiManagement.
*
*/
public String type() {
return this.type;
}
/**
* @return The type of VPN in which API Management gateway needs to be configured in.
*
*/
public Optional virtualNetworkType() {
return Optional.ofNullable(this.virtualNetworkType);
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(GetApiGatewayResult defaults) {
return new Builder(defaults);
}
@CustomType.Builder
public static final class Builder {
private @Nullable BackendConfigurationResponse backend;
private @Nullable GatewayConfigurationApiResponse configurationApi;
private String createdAtUtc;
private String etag;
private @Nullable FrontendConfigurationResponse frontend;
private String id;
private String location;
private String name;
private String provisioningState;
private ApiManagementGatewaySkuPropertiesResponse sku;
private SystemDataResponse systemData;
private @Nullable Map tags;
private String targetProvisioningState;
private String type;
private @Nullable String virtualNetworkType;
public Builder() {}
public Builder(GetApiGatewayResult defaults) {
Objects.requireNonNull(defaults);
this.backend = defaults.backend;
this.configurationApi = defaults.configurationApi;
this.createdAtUtc = defaults.createdAtUtc;
this.etag = defaults.etag;
this.frontend = defaults.frontend;
this.id = defaults.id;
this.location = defaults.location;
this.name = defaults.name;
this.provisioningState = defaults.provisioningState;
this.sku = defaults.sku;
this.systemData = defaults.systemData;
this.tags = defaults.tags;
this.targetProvisioningState = defaults.targetProvisioningState;
this.type = defaults.type;
this.virtualNetworkType = defaults.virtualNetworkType;
}
@CustomType.Setter
public Builder backend(@Nullable BackendConfigurationResponse backend) {
this.backend = backend;
return this;
}
@CustomType.Setter
public Builder configurationApi(@Nullable GatewayConfigurationApiResponse configurationApi) {
this.configurationApi = configurationApi;
return this;
}
@CustomType.Setter
public Builder createdAtUtc(String createdAtUtc) {
if (createdAtUtc == null) {
throw new MissingRequiredPropertyException("GetApiGatewayResult", "createdAtUtc");
}
this.createdAtUtc = createdAtUtc;
return this;
}
@CustomType.Setter
public Builder etag(String etag) {
if (etag == null) {
throw new MissingRequiredPropertyException("GetApiGatewayResult", "etag");
}
this.etag = etag;
return this;
}
@CustomType.Setter
public Builder frontend(@Nullable FrontendConfigurationResponse frontend) {
this.frontend = frontend;
return this;
}
@CustomType.Setter
public Builder id(String id) {
if (id == null) {
throw new MissingRequiredPropertyException("GetApiGatewayResult", "id");
}
this.id = id;
return this;
}
@CustomType.Setter
public Builder location(String location) {
if (location == null) {
throw new MissingRequiredPropertyException("GetApiGatewayResult", "location");
}
this.location = location;
return this;
}
@CustomType.Setter
public Builder name(String name) {
if (name == null) {
throw new MissingRequiredPropertyException("GetApiGatewayResult", "name");
}
this.name = name;
return this;
}
@CustomType.Setter
public Builder provisioningState(String provisioningState) {
if (provisioningState == null) {
throw new MissingRequiredPropertyException("GetApiGatewayResult", "provisioningState");
}
this.provisioningState = provisioningState;
return this;
}
@CustomType.Setter
public Builder sku(ApiManagementGatewaySkuPropertiesResponse sku) {
if (sku == null) {
throw new MissingRequiredPropertyException("GetApiGatewayResult", "sku");
}
this.sku = sku;
return this;
}
@CustomType.Setter
public Builder systemData(SystemDataResponse systemData) {
if (systemData == null) {
throw new MissingRequiredPropertyException("GetApiGatewayResult", "systemData");
}
this.systemData = systemData;
return this;
}
@CustomType.Setter
public Builder tags(@Nullable Map tags) {
this.tags = tags;
return this;
}
@CustomType.Setter
public Builder targetProvisioningState(String targetProvisioningState) {
if (targetProvisioningState == null) {
throw new MissingRequiredPropertyException("GetApiGatewayResult", "targetProvisioningState");
}
this.targetProvisioningState = targetProvisioningState;
return this;
}
@CustomType.Setter
public Builder type(String type) {
if (type == null) {
throw new MissingRequiredPropertyException("GetApiGatewayResult", "type");
}
this.type = type;
return this;
}
@CustomType.Setter
public Builder virtualNetworkType(@Nullable String virtualNetworkType) {
this.virtualNetworkType = virtualNetworkType;
return this;
}
public GetApiGatewayResult build() {
final var _resultValue = new GetApiGatewayResult();
_resultValue.backend = backend;
_resultValue.configurationApi = configurationApi;
_resultValue.createdAtUtc = createdAtUtc;
_resultValue.etag = etag;
_resultValue.frontend = frontend;
_resultValue.id = id;
_resultValue.location = location;
_resultValue.name = name;
_resultValue.provisioningState = provisioningState;
_resultValue.sku = sku;
_resultValue.systemData = systemData;
_resultValue.tags = tags;
_resultValue.targetProvisioningState = targetProvisioningState;
_resultValue.type = type;
_resultValue.virtualNetworkType = virtualNetworkType;
return _resultValue;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy