def test_list_rest_flattened_error(): client = RegionNotificationEndpointsClient( credentials=ga_credentials.AnonymousCredentials(), ) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): client.list( compute.ListRegionNotificationEndpointsRequest(), project="project_value", region="region_value", )
def __init__(self, method: Callable[..., compute.NotificationEndpointList], request: compute.ListRegionNotificationEndpointsRequest, response: compute.NotificationEndpointList, *, metadata: Sequence[Tuple[str, str]] = ()): """Instantiate the pager. Args: method (Callable): The method that was originally called, and which instantiated this pager. request (google.cloud.compute_v1.types.ListRegionNotificationEndpointsRequest): The initial request object. response (google.cloud.compute_v1.types.NotificationEndpointList): The initial response object. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. """ self._method = method self._request = compute.ListRegionNotificationEndpointsRequest(request) self._response = response self._metadata = metadata
def list( self, request: compute.ListRegionNotificationEndpointsRequest = None, *, project: str = None, region: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListPager: r"""Lists the NotificationEndpoints for a project in the given region. Args: request (google.cloud.compute_v1.types.ListRegionNotificationEndpointsRequest): The request object. A request message for RegionNotificationEndpoints.List. See the method description for details. project (str): Project ID for this request. This corresponds to the ``project`` field on the ``request`` instance; if ``request`` is provided, this should not be set. region (str): Name of the region scoping this request. This corresponds to the ``region`` field on the ``request`` instance; if ``request`` is provided, this should not be set. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: google.cloud.compute_v1.services.region_notification_endpoints.pagers.ListPager: Iterating over this object will yield results and resolve additional pages automatically. """ # Create or coerce a protobuf request object. # Sanity check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([project, region]) if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") # Minor optimization to avoid making a copy if the user passes # in a compute.ListRegionNotificationEndpointsRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, compute.ListRegionNotificationEndpointsRequest): request = compute.ListRegionNotificationEndpointsRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if region is not None: request.region = region # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.list] # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # This method is paged; wrap the response in a pager, which provides # an `__iter__` convenience method. response = pagers.ListPager( method=rpc, request=request, response=response, metadata=metadata, ) # Done; return the response. return response
def __call__( self, request: compute.ListRegionNotificationEndpointsRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> compute.NotificationEndpointList: r"""Call the list method over HTTP. Args: request (~.compute.ListRegionNotificationEndpointsRequest): The request object. A request message for RegionNotificationEndpoints.List. See the method description for details. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.compute.NotificationEndpointList: """ http_options = [ { "method": "get", "uri": "/compute/v1/projects/{project}/regions/{region}/notificationEndpoints", }, ] request_kwargs = compute.ListRegionNotificationEndpointsRequest.to_dict( request) transcoded_request = path_template.transcode( http_options, **request_kwargs) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( compute.ListRegionNotificationEndpointsRequest.to_json( compute.ListRegionNotificationEndpointsRequest( transcoded_request["query_params"]), including_default_value_fields=False, use_integers_for_enums=False, )) query_params.update(self._get_unset_required_fields(query_params)) # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( # Replace with proper schema configuration (http/https) logic "https://{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params), ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response return compute.NotificationEndpointList.from_json( response.content, ignore_unknown_fields=True)