def test_get_project_billing_info(transport: str = "grpc"):
client = CloudBillingClient(
credentials=credentials.AnonymousCredentials(), transport=transport
)
# Everything is optional in proto3 as far as the runtime is concerned,
# and we are mocking out the actual API, so just send an empty request.
request = cloud_billing.GetProjectBillingInfoRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(
type(client._transport.get_project_billing_info), "__call__"
) as call:
# Designate an appropriate return value for the call.
call.return_value = cloud_billing.ProjectBillingInfo(
name="name_value",
project_id="project_id_value",
billing_account_name="billing_account_name_value",
billing_enabled=True,
)
response = client.get_project_billing_info(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the response is the type that we expect.
assert isinstance(response, cloud_billing.ProjectBillingInfo)
assert response.name == "name_value"
assert response.project_id == "project_id_value"
assert response.billing_account_name == "billing_account_name_value"
assert response.billing_enabled == True
def test_get_project_billing_info_flattened_error():
client = CloudBillingClient(credentials=credentials.AnonymousCredentials())
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.get_project_billing_info(
cloud_billing.GetProjectBillingInfoRequest(), name="name_value")
def test_get_project_billing_info_field_headers():
client = CloudBillingClient(credentials=credentials.AnonymousCredentials())
# Any value that is part of the HTTP/1.1 URI should be sent as
# a field header. Set these to a non-empty value.
request = cloud_billing.GetProjectBillingInfoRequest(name="name/value")
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.get_project_billing_info),
"__call__") as call:
call.return_value = cloud_billing.ProjectBillingInfo()
client.get_project_billing_info(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the field header was sent.
_, _, kw = call.mock_calls[0]
assert ("x-goog-request-params", "name=name/value") in kw["metadata"]
def get_project_billing_info(
self,
request: cloud_billing.GetProjectBillingInfoRequest = None,
*,
name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cloud_billing.ProjectBillingInfo:
r"""Gets the billing information for a project. The current
authenticated user must have `permission to view the
project <https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo>`__.
Args:
request (:class:`~.cloud_billing.GetProjectBillingInfoRequest`):
The request object. Request message for
`GetProjectBillingInfo`.
name (:class:`str`):
Required. The resource name of the project for which
billing information is retrieved. For example,
``projects/tokyo-rain-123``.
This corresponds to the ``name`` 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:
~.cloud_billing.ProjectBillingInfo:
Encapsulation of billing information
for a GCP Console project. A project has
at most one associated billing account
at a time (but a billing account can be
assigned to multiple projects).
"""
# 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.
if request is not None and any([name]):
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = cloud_billing.GetProjectBillingInfoRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method.wrap_method(
self._transport.get_project_billing_info,
default_timeout=None,
client_info=_client_info,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name), )), )
# Send the request.
response = rpc(request,
retry=retry,
timeout=timeout,
metadata=metadata)
# Done; return the response.
return response
