2026-06-05
▼ ▲ networkservices.projects.locations.multicastConsumerAssociations.list
Path : v1/{+parent}/multicastConsumerAssociations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/multicastConsumerAssociations
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource for which to list multicast consumer associations. Use the following format: `projects/*/locations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of multicast consumer associations to return per call.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token from an earlier query, as returned in `next_page_token`.
Location : query
Type : string
filter
Description : Optional. A filter expression that filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `>`, `<=`, `>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: * Filter by name: name = "RESOURCE_NAME" * Filter by labels: * Resources that have a key named `foo` labels.foo:* * Resources that have a key named `foo` whose value is `bar` labels.foo = bar
Location : query
Type : string
orderBy
Description : Optional. A field used to sort the results by a certain order.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists multicast consumer associations in a given project and location.
▼ ▲ networkservices.projects.locations.multicastConsumerAssociations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/multicastConsumerAssociations/{multicastConsumerAssociationsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the multicast consumer association to get. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/multicastConsumerAssociations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single multicast consumer association.
▼ ▲ networkservices.projects.locations.multicastConsumerAssociations.create
Path : v1/{+parent}/multicastConsumerAssociations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/multicastConsumerAssociations
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource of the multicast consumer association. Use the following format: `projects/*/locations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
multicastConsumerAssociationId
Description : Required. A unique name for the multicast consumer association. The name is restricted to lower-case letters, numbers, and hyphen, with the first character a lower-case letter, and the last a letter or a number. The name must not exceed 48 characters.
Location : query
Type : string
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new multicast consumer association in a given project and location.
▼ ▲ networkservices.projects.locations.multicastConsumerAssociations.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/multicastConsumerAssociations/{multicastConsumerAssociationsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the multicast consumer association. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/multicastConsumerAssociations/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Field mask is used to specify the fields to be overwritten in the MulticastConsumerAssociation resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten.
Location : query
Type : string
Format : google-fieldmask
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single multicast consumer association.
▼ ▲ networkservices.projects.locations.multicastConsumerAssociations.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/multicastConsumerAssociations/{multicastConsumerAssociationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the multicast consumer association to delete. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/multicastConsumerAssociations/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single multicast consumer association.
▼ ▲ networkservices.projects.locations.multicastGroupConsumerActivations.list
Path : v1/{+parent}/multicastGroupConsumerActivations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/multicastGroupConsumerActivations
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource for which to list multicast group consumer activations. Use the following format: `projects/*/locations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of multicast group consumer activations to return per call.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token from an earlier query, as returned in `next_page_token`.
Location : query
Type : string
filter
Description : Optional. A filter expression that filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `>`, `<=`, `>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: * Filter by name: name = "RESOURCE_NAME" * Filter by labels: * Resources that have a key named `foo` labels.foo:* * Resources that have a key named `foo` whose value is `bar` labels.foo = bar
Location : query
Type : string
orderBy
Description : Optional. A field used to sort the results by a certain order.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists multicast group consumer activations in a given project and location.
▼ ▲ networkservices.projects.locations.multicastGroupConsumerActivations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/multicastGroupConsumerActivations/{multicastGroupConsumerActivationsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the multicast group consumer activation to get. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/multicastGroupConsumerActivations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single multicast group consumer activation.
▼ ▲ networkservices.projects.locations.multicastGroupConsumerActivations.create
Path : v1/{+parent}/multicastGroupConsumerActivations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/multicastGroupConsumerActivations
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource of the multicast group consumer activation. Use the following format: `projects/*/locations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
multicastGroupConsumerActivationId
Description : Required. A unique name for the multicast group consumer activation. The name is restricted to lower-case letters, numbers, and hyphen, with the first character a lower-case letter, and the last a letter or a number. The name must not exceed 48 characters.
Location : query
Type : string
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new multicast group consumer activation in a given project and location.
▼ ▲ networkservices.projects.locations.multicastGroupConsumerActivations.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/multicastGroupConsumerActivations/{multicastGroupConsumerActivationsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/multicastGroupConsumerActivations/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Field mask is used to specify the fields to be overwritten in the MulticastGroupConsumerActivation resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten.
Location : query
Type : string
Format : google-fieldmask
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single multicast group consumer activation.
▼ ▲ networkservices.projects.locations.multicastGroupConsumerActivations.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/multicastGroupConsumerActivations/{multicastGroupConsumerActivationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the multicast group consumer activation to delete. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/multicastGroupConsumerActivations/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single multicast group consumer activation.
▼ ▲ networkservices.projects.locations.agentGateways.list
Path : v1/{+parent}/agentGateways
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agentGateways
HTTP Method : GET
Parameters :
parent
Description : Required. The project and location from which the AgentGateways should be listed, specified in the format `projects/*/locations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Maximum number of AgentGateways to return per call.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The value returned by the last `ListAgentGatewaysResponse` Indicates that this is a continuation of a prior `ListAgentGateways` call, and that the system should return the next page of data.
Location : query
Type : string
returnPartialSuccess
Description : Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists AgentGateways in a given project and location.
▼ ▲ networkservices.projects.locations.agentGateways.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agentGateways/{agentGatewaysId}
HTTP Method : GET
Parameters :
name
Description : Required. A name of the AgentGateway to get. Must be in the format `projects/*/locations/*/agentGateways/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/agentGateways/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single AgentGateway.
▼ ▲ networkservices.projects.locations.agentGateways.create
Path : v1/{+parent}/agentGateways
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agentGateways
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource of the AgentGateway. Must be in the format `projects/*/locations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
agentGatewayId
Description : Required. Short name of the AgentGateway resource to be created.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new AgentGateway in a given project and location.
▼ ▲ networkservices.projects.locations.agentGateways.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agentGateways/{agentGatewaysId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agentGateways/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Field mask is used to specify the fields to be overwritten in the AgentGateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single AgentGateway.
▼ ▲ networkservices.projects.locations.agentGateways.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agentGateways/{agentGatewaysId}
HTTP Method : DELETE
Parameters :
name
Description : Required. A name of the AgentGateway to delete. Must be in the format `projects/*/locations/*/agentGateways/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/agentGateways/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. The etag of the AgentGateway to delete.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single AgentGateway.