StorageDataShareProperties Class

  • java.lang.Object
    • com.azure.resourcemanager.storage.models.StorageDataShareProperties

Implements

public final class StorageDataShareProperties
implements JsonSerializable<StorageDataShareProperties>

The storage datashare properties.

Constructor Summary

Constructor Description
StorageDataShareProperties()

Creates an instance of StorageDataShareProperties class.

Method Summary

Modifier and Type Method and Description
List<StorageDataShareAccessPolicy> accessPolicies()

Get the accessPolicies property: List of access policies that specify the permission allowed to a managed identity.

List<StorageDataShareAsset> assets()

Get the assets property: List of assets that specify the properties of the shared resources.

String dataShareIdentifier()

Get the dataShareIdentifier property: System-generated GUID identifier for the Storage DataShare.

String dataShareUri()

Get the dataShareUri property: The DataShare URI to be shared with the consumer.

String description()

Get the description property: Arbitrary description of this Data Share.

static StorageDataShareProperties fromJson(JsonReader jsonReader)

Reads an instance of StorageDataShareProperties from the JsonReader.

NativeDataSharingProvisioningState provisioningState()

Get the provisioningState property: Represents the provisioning state of the storage datashare.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

StorageDataShareProperties withAccessPolicies(List<StorageDataShareAccessPolicy> accessPolicies)

Set the accessPolicies property: List of access policies that specify the permission allowed to a managed identity.

StorageDataShareProperties withAssets(List<StorageDataShareAsset> assets)

Set the assets property: List of assets that specify the properties of the shared resources.

StorageDataShareProperties withDescription(String description)

Set the description property: Arbitrary description of this Data Share.

Methods inherited from java.lang.Object

Constructor Details

StorageDataShareProperties

public StorageDataShareProperties()

Creates an instance of StorageDataShareProperties class.

Method Details

accessPolicies

public List<StorageDataShareAccessPolicy> accessPolicies()

Get the accessPolicies property: List of access policies that specify the permission allowed to a managed identity. For Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged. If provided with a non-null value, the existing access policies are replaced with the specified list.

Returns:

the accessPolicies value.

assets

public List<StorageDataShareAsset> assets()

Get the assets property: List of assets that specify the properties of the shared resources. For Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing assets are left unchanged. If provided with a non-null value, the existing assets are replaced with the specified list.

Returns:

the assets value.

dataShareIdentifier

public String dataShareIdentifier()

Get the dataShareIdentifier property: System-generated GUID identifier for the Storage DataShare. Not a valid input parameter when creating.

Returns:

the dataShareIdentifier value.

dataShareUri

public String dataShareUri()

Get the dataShareUri property: The DataShare URI to be shared with the consumer. URI Format - 'azds://<location>:<dataShareName>:<dataShareIdentifier>'.

Returns:

the dataShareUri value.

description

public String description()

Get the description property: Arbitrary description of this Data Share. Max 250 characters.

Returns:

the description value.

fromJson

public static StorageDataShareProperties fromJson(JsonReader jsonReader)

Reads an instance of StorageDataShareProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of StorageDataShareProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

provisioningState

public NativeDataSharingProvisioningState provisioningState()

Get the provisioningState property: Represents the provisioning state of the storage datashare.

Returns:

the provisioningState value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withAccessPolicies

public StorageDataShareProperties withAccessPolicies(List<StorageDataShareAccessPolicy> accessPolicies)

Set the accessPolicies property: List of access policies that specify the permission allowed to a managed identity. For Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged. If provided with a non-null value, the existing access policies are replaced with the specified list.

Parameters:

accessPolicies - the accessPolicies value to set.

Returns:

the StorageDataShareProperties object itself.

withAssets

public StorageDataShareProperties withAssets(List<StorageDataShareAsset> assets)

Set the assets property: List of assets that specify the properties of the shared resources. For Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing assets are left unchanged. If provided with a non-null value, the existing assets are replaced with the specified list.

Parameters:

assets - the assets value to set.

Returns:

the StorageDataShareProperties object itself.

withDescription

public StorageDataShareProperties withDescription(String description)

Set the description property: Arbitrary description of this Data Share. Max 250 characters.

Parameters:

description - the description value to set.

Returns:

the StorageDataShareProperties object itself.

Applies to