AssignmentProperties Class

  • java.lang.Object
    • com.azure.resourcemanager.security.fluent.models.AssignmentProperties

Implements

public final class AssignmentProperties
implements JsonSerializable<AssignmentProperties>

Describes the properties of a standardAssignment.

Constructor Summary

Constructor Description
AssignmentProperties()

Creates an instance of AssignmentProperties class.

Method Summary

Modifier and Type Method and Description
AssignmentPropertiesAdditionalData additionalData()

Get the additionalData property: Additional data about the assignment.

AssignedComponentItem assignedComponent()

Get the assignedComponent property: Component item with key as applied to this standard assignment over the given scope.

AssignedStandardItem assignedStandard()

Get the assignedStandard property: Standard item with key as applied to this standard assignment over the given scope.

String description()

Get the description property: description of the standardAssignment.

String displayName()

Get the displayName property: display name of the standardAssignment.

String effect()

Get the effect property: expected effect of this assignment (Disable/Exempt/etc).

OffsetDateTime expiresOn()

Get the expiresOn property: Expiration date of this assignment as a full ISO date.

static AssignmentProperties fromJson(JsonReader jsonReader)

Reads an instance of AssignmentProperties from the JsonReader.

Object metadata()

Get the metadata property: The assignment metadata.

String scope()

Get the scope property: Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

AssignmentProperties withAdditionalData(AssignmentPropertiesAdditionalData additionalData)

Set the additionalData property: Additional data about the assignment.

AssignmentProperties withAssignedComponent(AssignedComponentItem assignedComponent)

Set the assignedComponent property: Component item with key as applied to this standard assignment over the given scope.

AssignmentProperties withAssignedStandard(AssignedStandardItem assignedStandard)

Set the assignedStandard property: Standard item with key as applied to this standard assignment over the given scope.

AssignmentProperties withDescription(String description)

Set the description property: description of the standardAssignment.

AssignmentProperties withDisplayName(String displayName)

Set the displayName property: display name of the standardAssignment.

AssignmentProperties withEffect(String effect)

Set the effect property: expected effect of this assignment (Disable/Exempt/etc).

AssignmentProperties withExpiresOn(OffsetDateTime expiresOn)

Set the expiresOn property: Expiration date of this assignment as a full ISO date.

AssignmentProperties withMetadata(Object metadata)

Set the metadata property: The assignment metadata.

AssignmentProperties withScope(String scope)

Set the scope property: Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription.

Methods inherited from java.lang.Object

Constructor Details

AssignmentProperties

public AssignmentProperties()

Creates an instance of AssignmentProperties class.

Method Details

additionalData

public AssignmentPropertiesAdditionalData additionalData()

Get the additionalData property: Additional data about the assignment.

Returns:

the additionalData value.

assignedComponent

public AssignedComponentItem assignedComponent()

Get the assignedComponent property: Component item with key as applied to this standard assignment over the given scope.

Returns:

the assignedComponent value.

assignedStandard

public AssignedStandardItem assignedStandard()

Get the assignedStandard property: Standard item with key as applied to this standard assignment over the given scope.

Returns:

the assignedStandard value.

description

public String description()

Get the description property: description of the standardAssignment.

Returns:

the description value.

displayName

public String displayName()

Get the displayName property: display name of the standardAssignment.

Returns:

the displayName value.

effect

public String effect()

Get the effect property: expected effect of this assignment (Disable/Exempt/etc).

Returns:

the effect value.

expiresOn

public OffsetDateTime expiresOn()

Get the expiresOn property: Expiration date of this assignment as a full ISO date.

Returns:

the expiresOn value.

fromJson

public static AssignmentProperties fromJson(JsonReader jsonReader)

Reads an instance of AssignmentProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the AssignmentProperties.

metadata

public Object metadata()

Get the metadata property: The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

Returns:

the metadata value.

scope

public String scope()

Get the scope property: Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription.

Returns:

the scope value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withAdditionalData

public AssignmentProperties withAdditionalData(AssignmentPropertiesAdditionalData additionalData)

Set the additionalData property: Additional data about the assignment.

Parameters:

additionalData - the additionalData value to set.

Returns:

the AssignmentProperties object itself.

withAssignedComponent

public AssignmentProperties withAssignedComponent(AssignedComponentItem assignedComponent)

Set the assignedComponent property: Component item with key as applied to this standard assignment over the given scope.

Parameters:

assignedComponent - the assignedComponent value to set.

Returns:

the AssignmentProperties object itself.

withAssignedStandard

public AssignmentProperties withAssignedStandard(AssignedStandardItem assignedStandard)

Set the assignedStandard property: Standard item with key as applied to this standard assignment over the given scope.

Parameters:

assignedStandard - the assignedStandard value to set.

Returns:

the AssignmentProperties object itself.

withDescription

public AssignmentProperties withDescription(String description)

Set the description property: description of the standardAssignment.

Parameters:

description - the description value to set.

Returns:

the AssignmentProperties object itself.

withDisplayName

public AssignmentProperties withDisplayName(String displayName)

Set the displayName property: display name of the standardAssignment.

Parameters:

displayName - the displayName value to set.

Returns:

the AssignmentProperties object itself.

withEffect

public AssignmentProperties withEffect(String effect)

Set the effect property: expected effect of this assignment (Disable/Exempt/etc).

Parameters:

effect - the effect value to set.

Returns:

the AssignmentProperties object itself.

withExpiresOn

public AssignmentProperties withExpiresOn(OffsetDateTime expiresOn)

Set the expiresOn property: Expiration date of this assignment as a full ISO date.

Parameters:

expiresOn - the expiresOn value to set.

Returns:

the AssignmentProperties object itself.

withMetadata

public AssignmentProperties withMetadata(Object metadata)

Set the metadata property: The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

Parameters:

metadata - the metadata value to set.

Returns:

the AssignmentProperties object itself.

withScope

public AssignmentProperties withScope(String scope)

Set the scope property: Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription.

Parameters:

scope - the scope value to set.

Returns:

the AssignmentProperties object itself.

Applies to