Gen1EnvironmentCreateOrUpdateParameters Class

public final class Gen1EnvironmentCreateOrUpdateParameters
extends EnvironmentCreateOrUpdateParameters

Parameters supplied to the Create or Update Environment operation for a Gen1 environment.

Constructor Summary

Constructor Description
Gen1EnvironmentCreateOrUpdateParameters()

Creates an instance of Gen1EnvironmentCreateOrUpdateParameters class.

Method Summary

Modifier and Type Method and Description
Duration dataRetentionTime()

Get the dataRetentionTime property: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.

List<TimeSeriesIdProperty> partitionKeyProperties()

Get the partitionKeyProperties property: The list of event properties which will be used to partition data in the environment.

StorageLimitExceededBehavior storageLimitExceededBehavior()

Get the storageLimitExceededBehavior property: The behavior the Time Series Insights service should take when the environment's capacity has been exceeded.

void validate()

Validates the instance.

Gen1EnvironmentCreateOrUpdateParameters withDataRetentionTime(Duration dataRetentionTime)

Set the dataRetentionTime property: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.

Gen1EnvironmentCreateOrUpdateParameters withLocation(String location)

Set the location property: The location of the resource.

Gen1EnvironmentCreateOrUpdateParameters withPartitionKeyProperties(List<TimeSeriesIdProperty> partitionKeyProperties)

Set the partitionKeyProperties property: The list of event properties which will be used to partition data in the environment.

Gen1EnvironmentCreateOrUpdateParameters withSku(Sku sku)

Set the sku property: The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1).

Gen1EnvironmentCreateOrUpdateParameters withStorageLimitExceededBehavior(StorageLimitExceededBehavior storageLimitExceededBehavior)

Set the storageLimitExceededBehavior property: The behavior the Time Series Insights service should take when the environment's capacity has been exceeded.

Gen1EnvironmentCreateOrUpdateParameters withTags(Map<String,String> tags)

Set the tags property: Key-value pairs of additional properties for the resource.

Methods inherited from CreateOrUpdateTrackedResourceProperties

Methods inherited from EnvironmentCreateOrUpdateParameters

Methods inherited from java.lang.Object

Constructor Details

Gen1EnvironmentCreateOrUpdateParameters

public Gen1EnvironmentCreateOrUpdateParameters()

Creates an instance of Gen1EnvironmentCreateOrUpdateParameters class.

Method Details

dataRetentionTime

public Duration dataRetentionTime()

Get the dataRetentionTime property: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.

Returns:

the dataRetentionTime value.

partitionKeyProperties

public List partitionKeyProperties()

Get the partitionKeyProperties property: The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.

Returns:

the partitionKeyProperties value.

storageLimitExceededBehavior

public StorageLimitExceededBehavior storageLimitExceededBehavior()

Get the storageLimitExceededBehavior property: The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.

Returns:

the storageLimitExceededBehavior value.

validate

public void validate()

Validates the instance.

Overrides:

Gen1EnvironmentCreateOrUpdateParameters.validate()

withDataRetentionTime

public Gen1EnvironmentCreateOrUpdateParameters withDataRetentionTime(Duration dataRetentionTime)

Set the dataRetentionTime property: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.

Parameters:

dataRetentionTime - the dataRetentionTime value to set.

Returns:

the Gen1EnvironmentCreateOrUpdateParameters object itself.

withLocation

public Gen1EnvironmentCreateOrUpdateParameters withLocation(String location)

Set the location property: The location of the resource.

Overrides:

Gen1EnvironmentCreateOrUpdateParameters.withLocation(String location)

Parameters:

location

withPartitionKeyProperties

public Gen1EnvironmentCreateOrUpdateParameters withPartitionKeyProperties(List partitionKeyProperties)

Set the partitionKeyProperties property: The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.

Parameters:

partitionKeyProperties - the partitionKeyProperties value to set.

Returns:

the Gen1EnvironmentCreateOrUpdateParameters object itself.

withSku

public Gen1EnvironmentCreateOrUpdateParameters withSku(Sku sku)

Set the sku property: The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.

Overrides:

Gen1EnvironmentCreateOrUpdateParameters.withSku(Sku sku)

Parameters:

sku

withStorageLimitExceededBehavior

public Gen1EnvironmentCreateOrUpdateParameters withStorageLimitExceededBehavior(StorageLimitExceededBehavior storageLimitExceededBehavior)

Set the storageLimitExceededBehavior property: The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.

Parameters:

storageLimitExceededBehavior - the storageLimitExceededBehavior value to set.

Returns:

the Gen1EnvironmentCreateOrUpdateParameters object itself.

withTags

public Gen1EnvironmentCreateOrUpdateParameters withTags(Map tags)

Set the tags property: Key-value pairs of additional properties for the resource.

Overrides:

Gen1EnvironmentCreateOrUpdateParameters.withTags(Map<String,String> tags)

Parameters:

tags

Applies to