* $networkservicesService = new Google\Service\NetworkServices(...); * $multicastConsumerAssociations = $networkservicesService->projects_locations_multicastConsumerAssociations; * */ class ProjectsLocationsMulticastConsumerAssociations extends \Google\Service\Resource { /** * Creates a new multicast consumer association in a given project and location. * (multicastConsumerAssociations.create) * * @param string $parent Required. The parent resource of the multicast consumer * association. Use the following format: `projects/locations`. * @param MulticastConsumerAssociation $postBody * @param array $optParams Optional parameters. * * @opt_param string multicastConsumerAssociationId 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. * @opt_param string requestId 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). * @return Operation * @throws \Google\Service\Exception */ public function create($parent, MulticastConsumerAssociation $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], Operation::class); } /** * Deletes a single multicast consumer association. * (multicastConsumerAssociations.delete) * * @param string $name Required. The resource name of the multicast consumer * association to delete. Use the following format: * `projects/locations/multicastConsumerAssociations`. * @param array $optParams Optional parameters. * * @opt_param string requestId 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). * @return Operation * @throws \Google\Service\Exception */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], Operation::class); } /** * Gets details of a single multicast consumer association. * (multicastConsumerAssociations.get) * * @param string $name Required. The resource name of the multicast consumer * association to get. Use the following format: * `projects/locations/multicastConsumerAssociations`. * @param array $optParams Optional parameters. * @return MulticastConsumerAssociation * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], MulticastConsumerAssociation::class); } /** * Lists multicast consumer associations in a given project and location. (multi * castConsumerAssociations.listProjectsLocationsMulticastConsumerAssociations) * * @param string $parent Required. The parent resource for which to list * multicast consumer associations. Use the following format: * `projects/locations`. * @param array $optParams Optional parameters. * * @opt_param string filter 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 * @opt_param string orderBy Optional. A field used to sort the results by a * certain order. * @opt_param int pageSize Optional. The maximum number of multicast consumer * associations to return per call. * @opt_param string pageToken Optional. A page token from an earlier query, as * returned in `next_page_token`. * @return ListMulticastConsumerAssociationsResponse * @throws \Google\Service\Exception */ public function listProjectsLocationsMulticastConsumerAssociations($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListMulticastConsumerAssociationsResponse::class); } /** * Updates the parameters of a single multicast consumer association. * (multicastConsumerAssociations.patch) * * @param string $name Identifier. The resource name of the multicast consumer * association. Use the following format: * `projects/locations/multicastConsumerAssociations`. * @param MulticastConsumerAssociation $postBody * @param array $optParams Optional parameters. * * @opt_param string requestId 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). * @opt_param string updateMask 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. * @return Operation * @throws \Google\Service\Exception */ public function patch($name, MulticastConsumerAssociation $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], Operation::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsMulticastConsumerAssociations::class, 'Google_Service_NetworkServices_Resource_ProjectsLocationsMulticastConsumerAssociations');