multicast_group_consumer_activations

Creates, updates, deletes, gets or lists a multicast_group_consumer_activations resource.

Overview

Name	multicast_group_consumer_activations
Type	Resource
Id	google.networkservices.multicast_group_consumer_activations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the multicast group consumer activation. Use the following format: projects/*/locations/*/multicastGroupConsumerActivations/*.
createTime	string (google-datetime)	Output only. [Output only] The timestamp when the multicast group consumer activation was created.
description	string	Optional. An optional text description of the multicast group consumer activation.
labels	object	Optional. Labels as key-value pairs
logConfig	object	Optional. Specifies the logging options for the activities performed related to the multicast group consumer activation. Defaults to false. If logging is enabled, logs are exported to Cloud Logging. (id: MulticastLogConfig)
multicastConsumerAssociation	string	Required. The resource name of the multicast consumer association that is in the same zone as this multicast group consumer activation. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
multicastGroup	string	Optional. The resource name of the multicast group created by the admin in the same zone as this multicast group consumer activation. Use the following format: // projects/*/locations/*/multicastGroups/*. This field is deprecated. Use multicast_group_range_activation instead.
multicastGroupRangeActivation	string	Required. The resource name of the multicast group range activation created by the admin in the same zone as this multicast group consumer activation. Use the following format: // projects/*/locations/*/multicastGroupRangeActivations/*.
resourceState	string	Output only. [Deprecated] The resource state of the multicast group consumer activation. Use the state field instead. (CONSUMER_RESOURCE_STATE_UNSPECIFIED, ACTIVE, OBSOLETE)
state	object	Output only. [Output only] The state of the resource. (id: MulticastResourceState)
uniqueId	string	Output only. [Output only] The Google-generated UUID for the resource. This value is unique across all multicast group consumer activation resources. If a group consumer activation is deleted and another with the same name is created, the new group consumer activation is assigned a different unique_id.
updateTime	string (google-datetime)	Output only. [Output only] The timestamp when the multicast group consumer activation was most recently updated.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the multicast group consumer activation. Use the following format: projects/*/locations/*/multicastGroupConsumerActivations/*.
createTime	string (google-datetime)	Output only. [Output only] The timestamp when the multicast group consumer activation was created.
description	string	Optional. An optional text description of the multicast group consumer activation.
labels	object	Optional. Labels as key-value pairs
logConfig	object	Optional. Specifies the logging options for the activities performed related to the multicast group consumer activation. Defaults to false. If logging is enabled, logs are exported to Cloud Logging. (id: MulticastLogConfig)
multicastConsumerAssociation	string	Required. The resource name of the multicast consumer association that is in the same zone as this multicast group consumer activation. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
multicastGroup	string	Optional. The resource name of the multicast group created by the admin in the same zone as this multicast group consumer activation. Use the following format: // projects/*/locations/*/multicastGroups/*. This field is deprecated. Use multicast_group_range_activation instead.
multicastGroupRangeActivation	string	Required. The resource name of the multicast group range activation created by the admin in the same zone as this multicast group consumer activation. Use the following format: // projects/*/locations/*/multicastGroupRangeActivations/*.
resourceState	string	Output only. [Deprecated] The resource state of the multicast group consumer activation. Use the state field instead. (CONSUMER_RESOURCE_STATE_UNSPECIFIED, ACTIVE, OBSOLETE)
state	object	Output only. [Output only] The state of the resource. (id: MulticastResourceState)
uniqueId	string	Output only. [Output only] The Google-generated UUID for the resource. This value is unique across all multicast group consumer activation resources. If a group consumer activation is deleted and another with the same name is created, the new group consumer activation is assigned a different unique_id.
updateTime	string (google-datetime)	Output only. [Output only] The timestamp when the multicast group consumer activation was most recently updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, multicastGroupConsumerActivationsId		Gets details of a single multicast group consumer activation.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists multicast group consumer activations in a given project and location.
create	insert	projectsId, locationsId	multicastGroupConsumerActivationId, requestId	Creates a new multicast group consumer activation in a given project and location.
patch	update	projectsId, locationsId, multicastGroupConsumerActivationsId	updateMask, requestId	Updates the parameters of a single multicast group consumer activation.
delete	delete	projectsId, locationsId, multicastGroupConsumerActivationsId	requestId	Deletes a single multicast group consumer activation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
multicastGroupConsumerActivationsId	string
projectsId	string
filter	string
multicastGroupConsumerActivationId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single multicast group consumer activation.

SELECT
name,
createTime,
description,
labels,
logConfig,
multicastConsumerAssociation,
multicastGroup,
multicastGroupRangeActivation,
resourceState,
state,
uniqueId,
updateTime
FROM google.networkservices.multicast_group_consumer_activations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND multicastGroupConsumerActivationsId = '{{ multicastGroupConsumerActivationsId }}' -- required
;

list

Lists multicast group consumer activations in a given project and location.

SELECT
name,
createTime,
description,
labels,
logConfig,
multicastConsumerAssociation,
multicastGroup,
multicastGroupRangeActivation,
resourceState,
state,
uniqueId,
updateTime
FROM google.networkservices.multicast_group_consumer_activations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a new multicast group consumer activation in a given project and location.

INSERT INTO google.networkservices.multicast_group_consumer_activations (
data__name,
data__labels,
data__multicastConsumerAssociation,
data__multicastGroup,
data__description,
data__multicastGroupRangeActivation,
data__logConfig,
projectsId,
locationsId,
multicastGroupConsumerActivationId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ multicastConsumerAssociation }}',
'{{ multicastGroup }}',
'{{ description }}',
'{{ multicastGroupRangeActivation }}',
'{{ logConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ multicastGroupConsumerActivationId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: multicast_group_consumer_activations
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the multicast_group_consumer_activations resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the multicast_group_consumer_activations resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels as key-value pairs
  - name: multicastConsumerAssociation
    value: "{{ multicastConsumerAssociation }}"
    description: |
      Required. The resource name of the multicast consumer association that is in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`.
  - name: multicastGroup
    value: "{{ multicastGroup }}"
    description: |
      Optional. The resource name of the multicast group created by the admin in the same zone as this multicast group consumer activation. Use the following format: // `projects/*/locations/*/multicastGroups/*`. This field is deprecated. Use multicast_group_range_activation instead.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. An optional text description of the multicast group consumer activation.
  - name: multicastGroupRangeActivation
    value: "{{ multicastGroupRangeActivation }}"
    description: |
      Required. The resource name of the multicast group range activation created by the admin in the same zone as this multicast group consumer activation. Use the following format: // `projects/*/locations/*/multicastGroupRangeActivations/*`.
  - name: logConfig
    description: |
      Optional. Specifies the logging options for the activities performed related to the multicast group consumer activation. Defaults to false. If logging is enabled, logs are exported to Cloud Logging.
    value:
      enabled: {{ enabled }}
  - name: multicastGroupConsumerActivationId
    value: "{{ multicastGroupConsumerActivationId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the parameters of a single multicast group consumer activation.

UPDATE google.networkservices.multicast_group_consumer_activations
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__multicastConsumerAssociation = '{{ multicastConsumerAssociation }}',
data__multicastGroup = '{{ multicastGroup }}',
data__description = '{{ description }}',
data__multicastGroupRangeActivation = '{{ multicastGroupRangeActivation }}',
data__logConfig = '{{ logConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND multicastGroupConsumerActivationsId = '{{ multicastGroupConsumerActivationsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single multicast group consumer activation.

DELETE FROM google.networkservices.multicast_group_consumer_activations
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND multicastGroupConsumerActivationsId = '{{ multicastGroupConsumerActivationsId }}' --required
AND requestId = '{{ requestId }}'
;