com.pulumi.azurenative.search.outputs.GetServiceResult 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.search.outputs;
import com.pulumi.azurenative.search.outputs.DataPlaneAuthOptionsResponse;
import com.pulumi.azurenative.search.outputs.EncryptionWithCmkResponse;
import com.pulumi.azurenative.search.outputs.IdentityResponse;
import com.pulumi.azurenative.search.outputs.NetworkRuleSetResponse;
import com.pulumi.azurenative.search.outputs.PrivateEndpointConnectionResponse;
import com.pulumi.azurenative.search.outputs.SharedPrivateLinkResourceResponse;
import com.pulumi.azurenative.search.outputs.SkuResponse;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
@CustomType
public final class GetServiceResult {
/**
* @return Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
*
*/
private @Nullable DataPlaneAuthOptionsResponse authOptions;
/**
* @return When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
*
*/
private @Nullable Boolean disableLocalAuth;
/**
* @return Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
*
*/
private @Nullable EncryptionWithCmkResponse encryptionWithCmk;
/**
* @return Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.
*
*/
private @Nullable String hostingMode;
/**
* @return Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*
*/
private String id;
/**
* @return The identity of the resource.
*
*/
private @Nullable IdentityResponse identity;
/**
* @return The geo-location where the resource lives
*
*/
private String location;
/**
* @return The name of the resource
*
*/
private String name;
/**
* @return Network specific rules that determine how the Azure Cognitive Search service may be reached.
*
*/
private @Nullable NetworkRuleSetResponse networkRuleSet;
/**
* @return The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.
*
*/
private @Nullable Integer partitionCount;
/**
* @return The list of private endpoint connections to the Azure Cognitive Search service.
*
*/
private List privateEndpointConnections;
/**
* @return The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
*
*/
private String provisioningState;
/**
* @return This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
*
*/
private @Nullable String publicNetworkAccess;
/**
* @return The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.
*
*/
private @Nullable Integer replicaCount;
/**
* @return The list of shared private link resources managed by the Azure Cognitive Search service.
*
*/
private List sharedPrivateLinkResources;
/**
* @return The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.
*
*/
private @Nullable SkuResponse sku;
/**
* @return The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
*
*/
private String status;
/**
* @return The details of the search service status.
*
*/
private String statusDetails;
/**
* @return Resource tags.
*
*/
private @Nullable Map tags;
/**
* @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
private String type;
private GetServiceResult() {}
/**
* @return Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
*
*/
public Optional authOptions() {
return Optional.ofNullable(this.authOptions);
}
/**
* @return When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
*
*/
public Optional disableLocalAuth() {
return Optional.ofNullable(this.disableLocalAuth);
}
/**
* @return Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
*
*/
public Optional encryptionWithCmk() {
return Optional.ofNullable(this.encryptionWithCmk);
}
/**
* @return Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.
*
*/
public Optional hostingMode() {
return Optional.ofNullable(this.hostingMode);
}
/**
* @return Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*
*/
public String id() {
return this.id;
}
/**
* @return The identity of the resource.
*
*/
public Optional identity() {
return Optional.ofNullable(this.identity);
}
/**
* @return The geo-location where the resource lives
*
*/
public String location() {
return this.location;
}
/**
* @return The name of the resource
*
*/
public String name() {
return this.name;
}
/**
* @return Network specific rules that determine how the Azure Cognitive Search service may be reached.
*
*/
public Optional networkRuleSet() {
return Optional.ofNullable(this.networkRuleSet);
}
/**
* @return The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.
*
*/
public Optional partitionCount() {
return Optional.ofNullable(this.partitionCount);
}
/**
* @return The list of private endpoint connections to the Azure Cognitive Search service.
*
*/
public List privateEndpointConnections() {
return this.privateEndpointConnections;
}
/**
* @return The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
*
*/
public String provisioningState() {
return this.provisioningState;
}
/**
* @return This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
*
*/
public Optional publicNetworkAccess() {
return Optional.ofNullable(this.publicNetworkAccess);
}
/**
* @return The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.
*
*/
public Optional replicaCount() {
return Optional.ofNullable(this.replicaCount);
}
/**
* @return The list of shared private link resources managed by the Azure Cognitive Search service.
*
*/
public List sharedPrivateLinkResources() {
return this.sharedPrivateLinkResources;
}
/**
* @return The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.
*
*/
public Optional sku() {
return Optional.ofNullable(this.sku);
}
/**
* @return The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
*
*/
public String status() {
return this.status;
}
/**
* @return The details of the search service status.
*
*/
public String statusDetails() {
return this.statusDetails;
}
/**
* @return Resource tags.
*
*/
public Map tags() {
return this.tags == null ? Map.of() : this.tags;
}
/**
* @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(GetServiceResult defaults) {
return new Builder(defaults);
}
@CustomType.Builder
public static final class Builder {
private @Nullable DataPlaneAuthOptionsResponse authOptions;
private @Nullable Boolean disableLocalAuth;
private @Nullable EncryptionWithCmkResponse encryptionWithCmk;
private @Nullable String hostingMode;
private String id;
private @Nullable IdentityResponse identity;
private String location;
private String name;
private @Nullable NetworkRuleSetResponse networkRuleSet;
private @Nullable Integer partitionCount;
private List privateEndpointConnections;
private String provisioningState;
private @Nullable String publicNetworkAccess;
private @Nullable Integer replicaCount;
private List sharedPrivateLinkResources;
private @Nullable SkuResponse sku;
private String status;
private String statusDetails;
private @Nullable Map tags;
private String type;
public Builder() {}
public Builder(GetServiceResult defaults) {
Objects.requireNonNull(defaults);
this.authOptions = defaults.authOptions;
this.disableLocalAuth = defaults.disableLocalAuth;
this.encryptionWithCmk = defaults.encryptionWithCmk;
this.hostingMode = defaults.hostingMode;
this.id = defaults.id;
this.identity = defaults.identity;
this.location = defaults.location;
this.name = defaults.name;
this.networkRuleSet = defaults.networkRuleSet;
this.partitionCount = defaults.partitionCount;
this.privateEndpointConnections = defaults.privateEndpointConnections;
this.provisioningState = defaults.provisioningState;
this.publicNetworkAccess = defaults.publicNetworkAccess;
this.replicaCount = defaults.replicaCount;
this.sharedPrivateLinkResources = defaults.sharedPrivateLinkResources;
this.sku = defaults.sku;
this.status = defaults.status;
this.statusDetails = defaults.statusDetails;
this.tags = defaults.tags;
this.type = defaults.type;
}
@CustomType.Setter
public Builder authOptions(@Nullable DataPlaneAuthOptionsResponse authOptions) {
this.authOptions = authOptions;
return this;
}
@CustomType.Setter
public Builder disableLocalAuth(@Nullable Boolean disableLocalAuth) {
this.disableLocalAuth = disableLocalAuth;
return this;
}
@CustomType.Setter
public Builder encryptionWithCmk(@Nullable EncryptionWithCmkResponse encryptionWithCmk) {
this.encryptionWithCmk = encryptionWithCmk;
return this;
}
@CustomType.Setter
public Builder hostingMode(@Nullable String hostingMode) {
this.hostingMode = hostingMode;
return this;
}
@CustomType.Setter
public Builder id(String id) {
if (id == null) {
throw new MissingRequiredPropertyException("GetServiceResult", "id");
}
this.id = id;
return this;
}
@CustomType.Setter
public Builder identity(@Nullable IdentityResponse identity) {
this.identity = identity;
return this;
}
@CustomType.Setter
public Builder location(String location) {
if (location == null) {
throw new MissingRequiredPropertyException("GetServiceResult", "location");
}
this.location = location;
return this;
}
@CustomType.Setter
public Builder name(String name) {
if (name == null) {
throw new MissingRequiredPropertyException("GetServiceResult", "name");
}
this.name = name;
return this;
}
@CustomType.Setter
public Builder networkRuleSet(@Nullable NetworkRuleSetResponse networkRuleSet) {
this.networkRuleSet = networkRuleSet;
return this;
}
@CustomType.Setter
public Builder partitionCount(@Nullable Integer partitionCount) {
this.partitionCount = partitionCount;
return this;
}
@CustomType.Setter
public Builder privateEndpointConnections(List privateEndpointConnections) {
if (privateEndpointConnections == null) {
throw new MissingRequiredPropertyException("GetServiceResult", "privateEndpointConnections");
}
this.privateEndpointConnections = privateEndpointConnections;
return this;
}
public Builder privateEndpointConnections(PrivateEndpointConnectionResponse... privateEndpointConnections) {
return privateEndpointConnections(List.of(privateEndpointConnections));
}
@CustomType.Setter
public Builder provisioningState(String provisioningState) {
if (provisioningState == null) {
throw new MissingRequiredPropertyException("GetServiceResult", "provisioningState");
}
this.provisioningState = provisioningState;
return this;
}
@CustomType.Setter
public Builder publicNetworkAccess(@Nullable String publicNetworkAccess) {
this.publicNetworkAccess = publicNetworkAccess;
return this;
}
@CustomType.Setter
public Builder replicaCount(@Nullable Integer replicaCount) {
this.replicaCount = replicaCount;
return this;
}
@CustomType.Setter
public Builder sharedPrivateLinkResources(List sharedPrivateLinkResources) {
if (sharedPrivateLinkResources == null) {
throw new MissingRequiredPropertyException("GetServiceResult", "sharedPrivateLinkResources");
}
this.sharedPrivateLinkResources = sharedPrivateLinkResources;
return this;
}
public Builder sharedPrivateLinkResources(SharedPrivateLinkResourceResponse... sharedPrivateLinkResources) {
return sharedPrivateLinkResources(List.of(sharedPrivateLinkResources));
}
@CustomType.Setter
public Builder sku(@Nullable SkuResponse sku) {
this.sku = sku;
return this;
}
@CustomType.Setter
public Builder status(String status) {
if (status == null) {
throw new MissingRequiredPropertyException("GetServiceResult", "status");
}
this.status = status;
return this;
}
@CustomType.Setter
public Builder statusDetails(String statusDetails) {
if (statusDetails == null) {
throw new MissingRequiredPropertyException("GetServiceResult", "statusDetails");
}
this.statusDetails = statusDetails;
return this;
}
@CustomType.Setter
public Builder tags(@Nullable Map tags) {
this.tags = tags;
return this;
}
@CustomType.Setter
public Builder type(String type) {
if (type == null) {
throw new MissingRequiredPropertyException("GetServiceResult", "type");
}
this.type = type;
return this;
}
public GetServiceResult build() {
final var _resultValue = new GetServiceResult();
_resultValue.authOptions = authOptions;
_resultValue.disableLocalAuth = disableLocalAuth;
_resultValue.encryptionWithCmk = encryptionWithCmk;
_resultValue.hostingMode = hostingMode;
_resultValue.id = id;
_resultValue.identity = identity;
_resultValue.location = location;
_resultValue.name = name;
_resultValue.networkRuleSet = networkRuleSet;
_resultValue.partitionCount = partitionCount;
_resultValue.privateEndpointConnections = privateEndpointConnections;
_resultValue.provisioningState = provisioningState;
_resultValue.publicNetworkAccess = publicNetworkAccess;
_resultValue.replicaCount = replicaCount;
_resultValue.sharedPrivateLinkResources = sharedPrivateLinkResources;
_resultValue.sku = sku;
_resultValue.status = status;
_resultValue.statusDetails = statusDetails;
_resultValue.tags = tags;
_resultValue.type = type;
return _resultValue;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy