multicast_consumer_associations

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

Overview

Name	multicast_consumer_associations
Type	Resource
Id	google.networkservices.multicast_consumer_associations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
createTime	string (google-datetime)	Output only. [Output only] The timestamp when the multicast consumer association was created.
description	string	Optional. An optional text description of the multicast consumer association.
labels	object	Optional. Labels as key-value pairs
multicastDomainActivation	string	Optional. The resource name of the multicast domain activation that is in the same zone as this multicast consumer association. Use the following format: projects/*/locations/*/multicastDomainActivations/*.
network	string	Required. The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
placementPolicy	string	Output only. [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
resourceState	string	Output only. [Deprecated] The resource state of the multicast consumer association. 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 consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
updateTime	string (google-datetime)	Output only. [Output only] The timestamp when the Multicast Consumer Association was most recently updated.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
createTime	string (google-datetime)	Output only. [Output only] The timestamp when the multicast consumer association was created.
description	string	Optional. An optional text description of the multicast consumer association.
labels	object	Optional. Labels as key-value pairs
multicastDomainActivation	string	Optional. The resource name of the multicast domain activation that is in the same zone as this multicast consumer association. Use the following format: projects/*/locations/*/multicastDomainActivations/*.
network	string	Required. The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
placementPolicy	string	Output only. [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
resourceState	string	Output only. [Deprecated] The resource state of the multicast consumer association. 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 consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
updateTime	string (google-datetime)	Output only. [Output only] The timestamp when the Multicast Consumer Association 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, multicastConsumerAssociationsId		Gets details of a single multicast consumer association.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists multicast consumer associations in a given project and location.
create	insert	projectsId, locationsId	multicastConsumerAssociationId, requestId	Creates a new multicast consumer association in a given project and location.
patch	update	projectsId, locationsId, multicastConsumerAssociationsId	updateMask, requestId	Updates the parameters of a single multicast consumer association.
delete	delete	projectsId, locationsId, multicastConsumerAssociationsId	requestId	Deletes a single multicast consumer association.

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
multicastConsumerAssociationsId	string
projectsId	string
filter	string
multicastConsumerAssociationId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single multicast consumer association.

SELECT
name,
createTime,
description,
labels,
multicastDomainActivation,
network,
placementPolicy,
resourceState,
state,
uniqueId,
updateTime
FROM google.networkservices.multicast_consumer_associations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND multicastConsumerAssociationsId = '{{ multicastConsumerAssociationsId }}' -- required
;

list

Lists multicast consumer associations in a given project and location.

SELECT
name,
createTime,
description,
labels,
multicastDomainActivation,
network,
placementPolicy,
resourceState,
state,
uniqueId,
updateTime
FROM google.networkservices.multicast_consumer_associations
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 consumer association in a given project and location.

INSERT INTO google.networkservices.multicast_consumer_associations (
data__name,
data__labels,
data__multicastDomainActivation,
data__network,
data__description,
projectsId,
locationsId,
multicastConsumerAssociationId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ multicastDomainActivation }}',
'{{ network }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ multicastConsumerAssociationId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: multicast_consumer_associations
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the multicast_consumer_associations resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the multicast_consumer_associations resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the multicast consumer association. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels as key-value pairs
  - name: multicastDomainActivation
    value: "{{ multicastDomainActivation }}"
    description: |
      Optional. The resource name of the multicast domain activation that is in the same zone as this multicast consumer association. Use the following format: `projects/*/locations/*/multicastDomainActivations/*`.
  - name: network
    value: "{{ network }}"
    description: |
      Required. The resource name of the multicast consumer VPC network. Use following format: `projects/{project}/locations/global/networks/{network}`.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. An optional text description of the multicast consumer association.
  - name: multicastConsumerAssociationId
    value: "{{ multicastConsumerAssociationId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the parameters of a single multicast consumer association.

UPDATE google.networkservices.multicast_consumer_associations
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__multicastDomainActivation = '{{ multicastDomainActivation }}',
data__network = '{{ network }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND multicastConsumerAssociationsId = '{{ multicastConsumerAssociationsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single multicast consumer association.

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