Class: Azure::DataShare::Mgmt::V2019_11_01::Models::Invitation

Inherits:
ProxyDto
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-11-01/generated/azure_mgmt_datashare/models/invitation.rb

Overview

A Invitation data transfer object.

Instance Attribute Summary collapse

Attributes inherited from ProxyDto

#id, #name, #type

Class Method Summary collapse

Instance Attribute Details

#invitation_id ⇒ String

Returns unique invitation id.

Returns:

  • (String) —

    unique invitation id



16
17
18
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/models/invitation.rb', line 16

def invitation_id
  @invitation_id
end

#invitation_status ⇒ InvitationStatus

values include: ‘Pending’, ‘Accepted’, ‘Rejected’, ‘Withdrawn’

Returns:



20
21
22
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/models/invitation.rb', line 20

def invitation_status
  @invitation_status
end

#responded_at ⇒ DateTime

Returns The time the recipient responded to the invitation.

Returns:

  • (DateTime) —

    The time the recipient responded to the invitation.



23
24
25
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/models/invitation.rb', line 23

def responded_at
  @responded_at
end

#sent_at ⇒ DateTime

Returns Gets the time at which the invitation was sent.

Returns:

  • (DateTime) —

    Gets the time at which the invitation was sent.



26
27
28
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/models/invitation.rb', line 26

def sent_at
  @sent_at
end

#target_active_directory_id ⇒ String

Returns The target Azure AD Id. Can’t be combined with email.

Returns:

  • (String) —

    The target Azure AD Id. Can’t be combined with email.



29
30
31
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/models/invitation.rb', line 29

def target_active_directory_id
  @target_active_directory_id
end

#target_email ⇒ String

Returns The email the invitation is directed to.

Returns:

  • (String) —

    The email the invitation is directed to.



32
33
34
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/models/invitation.rb', line 32

def target_email
  @target_email
end

#target_object_id ⇒ String

being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant.

Returns:

  • (String) —

    The target user or application Id that invitation is



38
39
40
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/models/invitation.rb', line 38

def target_object_id
  @target_object_id
end

#user_email ⇒ String

Returns Email of the user who created the resource.

Returns:

  • (String) —

    Email of the user who created the resource



41
42
43
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/models/invitation.rb', line 41

def user_email
  @user_email
end

#user_name ⇒ String

Returns Name of the user who created the resource.

Returns:

  • (String) —

    Name of the user who created the resource



44
45
46
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/models/invitation.rb', line 44

def user_name
  @user_name
end

Class Method Details

.mapper ⇒ Object

Mapper for Invitation class as Ruby Hash. This will be used for serialization/deserialization.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/models/invitation.rb', line 51

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Invitation',
    type: {
      name: 'Composite',
      class_name: 'Invitation',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        invitation_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.invitationId',
          type: {
            name: 'String'
          }
        },
        invitation_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.invitationStatus',
          type: {
            name: 'String'
          }
        },
        responded_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.respondedAt',
          type: {
            name: 'DateTime'
          }
        },
        sent_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.sentAt',
          type: {
            name: 'DateTime'
          }
        },
        target_active_directory_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.targetActiveDirectoryId',
          type: {
            name: 'String'
          }
        },
        target_email: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.targetEmail',
          type: {
            name: 'String'
          }
        },
        target_object_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.targetObjectId',
          type: {
            name: 'String'
          }
        },
        user_email: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.userEmail',
          type: {
            name: 'String'
          }
        },
        user_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.userName',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end