class Azure::EventGrid::Mgmt::V2020_10_15_preview::Models::EventChannel

Event Channel.

Attributes

destination[RW]

@return [EventChannelDestination] Represents the destination of an event channel.

expiration_time_if_not_activated_utc[RW]

@return [DateTime] Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, the event channel and corresponding partner topic are deleted.

filter[RW]

@return [EventChannelFilter] Information about the filter for the event channel.

partner_topic_friendly_description[RW]

@return [String] Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.

partner_topic_readiness_state[RW]

@return [PartnerTopicReadinessState] The readiness state of the corresponding partner topic. Possible values include: 'NotActivatedByUserYet', 'ActivatedByUser', 'DeactivatedByUser', 'DeletedByUser'

provisioning_state[RW]

@return [EventChannelProvisioningState] Provisioning state of the event channel. Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Canceled', 'Failed'

source[RW]

@return [EventChannelSource] Source of the event channel. This represents a unique resource in the partner's resource model.

system_data[RW]

@return [SystemData] The system metadata relating to Event Channel resource.

Private Class Methods

mapper() click to toggle source

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

# File lib/2020-10-15-preview/generated/azure_mgmt_event_grid/models/event_channel.rb, line 59
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'EventChannel',
    type: {
      name: 'Composite',
      class_name: 'EventChannel',
      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'
          }
        },
        source: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.source',
          type: {
            name: 'Composite',
            class_name: 'EventChannelSource'
          }
        },
        destination: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.destination',
          type: {
            name: 'Composite',
            class_name: 'EventChannelDestination'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        partner_topic_readiness_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.partnerTopicReadinessState',
          type: {
            name: 'String'
          }
        },
        expiration_time_if_not_activated_utc: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.expirationTimeIfNotActivatedUtc',
          type: {
            name: 'DateTime'
          }
        },
        filter: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.filter',
          type: {
            name: 'Composite',
            class_name: 'EventChannelFilter'
          }
        },
        partner_topic_friendly_description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.partnerTopicFriendlyDescription',
          type: {
            name: 'String'
          }
        },
        system_data: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'systemData',
          type: {
            name: 'Composite',
            class_name: 'SystemData'
          }
        }
      }
    }
  }
end