Move .NET serialization attributes to Pulumi namespace, deprecate the ones in Pulumi.Serialization
79 lines
2.7 KiB
C#
79 lines
2.7 KiB
C#
// Copyright 2016-2019, Pulumi Corporation
|
|
|
|
using System;
|
|
using Google.Protobuf.WellKnownTypes;
|
|
|
|
namespace Pulumi
|
|
{
|
|
/// <summary>
|
|
/// Attribute used by a mark <see cref="Resource"/> output properties. Use this attribute
|
|
/// in your Pulumi programs to mark outputs of <see cref="ComponentResource"/> and
|
|
/// <see cref="Stack"/> resources.
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Property)]
|
|
public sealed class OutputAttribute : Attribute
|
|
{
|
|
public string? Name { get; }
|
|
|
|
public OutputAttribute(string? name = null)
|
|
{
|
|
Name = name;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Attribute used by a Pulumi Cloud Provider Package to mark <see cref="Resource"/> input
|
|
/// fields and properties.
|
|
/// <para/>
|
|
/// Note: for simple inputs (i.e. <see cref="Input{T}"/> this should just be placed on the
|
|
/// property itself. i.e. <c>[Input] Input<string> Acl</c>.
|
|
///
|
|
/// For collection inputs (i.e. <see cref="InputList{T}"/> this should be placed on the
|
|
/// backing field for the property. i.e.
|
|
///
|
|
/// <code>
|
|
/// [Input] private InputList<string> _acls;
|
|
/// public InputList<string> Acls
|
|
/// {
|
|
/// get => _acls ?? (_acls = new InputList<string>());
|
|
/// set => _acls = value;
|
|
/// }
|
|
/// </code>
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
|
|
public sealed class InputAttribute : Attribute
|
|
{
|
|
internal string Name { get; }
|
|
internal bool IsRequired { get; }
|
|
internal bool Json { get; }
|
|
|
|
public InputAttribute(string name, bool required = false, bool json = false)
|
|
{
|
|
Name = name;
|
|
IsRequired = required;
|
|
Json = json;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Attribute used by a Pulumi Cloud Provider Package to mark complex types used for a Resource
|
|
/// output property. A complex type must have a single constructor in it marked with the
|
|
/// <see cref="OutputConstructorAttribute"/> attribute.
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Class)]
|
|
public sealed class OutputTypeAttribute : Attribute
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Attribute used by a Pulumi Cloud Provider Package to marks the constructor for a complex
|
|
/// property type so that it can be instantiated by the Pulumi runtime.
|
|
///
|
|
/// The constructor should contain parameters that map to the resultant <see
|
|
/// cref="Struct.Fields"/> returned by the engine.
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Constructor)]
|
|
public sealed class OutputConstructorAttribute : Attribute
|
|
{
|
|
}
|
|
}
|