def get_login_profile(
self,
name,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Retrieves the profile information used for logging in to a virtual machine
on Google Compute Engine.
Example:
>>> from google.cloud import oslogin_v1
>>>
>>> client = oslogin_v1.OsLoginServiceClient()
>>>
>>> name = client.user_path('[USER]')
>>>
>>> response = client.get_login_profile(name)
Args:
name (str): The unique ID for the user in format ``users/{user}``.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata
that is provided to the method.
Returns:
A :class:`~google.cloud.oslogin_v1.types.LoginProfile` instance.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request
failed for any reason.
google.api_core.exceptions.RetryError: If the request failed due
to a retryable error and retry attempts failed.
ValueError: If the parameters are invalid.
"""
# Wrap the transport method to add retry and timeout logic.
if "get_login_profile" not in self._inner_api_calls:
self._inner_api_calls[
"get_login_profile"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.get_login_profile,
default_retry=self._method_configs["GetLoginProfile"].
retry,
default_timeout=self._method_configs["GetLoginProfile"].
timeout,
client_info=self._client_info,
)
request = oslogin_pb2.GetLoginProfileRequest(name=name)
return self._inner_api_calls["get_login_profile"](request,
retry=retry,
timeout=timeout,
metadata=metadata)
def test_get_login_profile(self):
# Setup Expected Response
name_2 = 'name2-1052831874'
suspended = False
expected_response = {'name': name_2, 'suspended': suspended}
expected_response = oslogin_pb2.LoginProfile(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
client = oslogin_v1.OsLoginServiceClient(channel=channel)
# Setup Request
name = client.user_path('[USER]')
response = client.get_login_profile(name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = oslogin_pb2.GetLoginProfileRequest(name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_get_login_profile(self):
# Setup Expected Response
name_2 = "name2-1052831874"
expected_response = {"name": name_2}
expected_response = oslogin_pb2.LoginProfile(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
patch = mock.patch("google.api_core.grpc_helpers.create_channel")
with patch as create_channel:
create_channel.return_value = channel
client = oslogin_v1.OsLoginServiceClient()
# Setup Request
name = client.user_path("[USER]")
response = client.get_login_profile(name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = oslogin_pb2.GetLoginProfileRequest(name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request