def test_create_realm_flattened_error(): client = RealmsServiceClient( credentials=credentials.AnonymousCredentials()) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): client.create_realm( realms.CreateRealmRequest(), parent="parent_value", realm=realms.Realm(name="name_value"), realm_id="realm_id_value", )
def create_realm(project_id, location, realm_id): """Creates a realm.""" client = gaming.RealmsServiceClient() request = realms.CreateRealmRequest( parent=f"projects/{project_id}/locations/{location}", realm_id=realm_id, realm=realms.Realm( description="My Realm", time_zone="US/Pacific", ), ) operation = client.create_realm(request) print(f"Create realm operation: {operation.operation.name}") operation.result(timeout=120)
def test_create_realm(transport: str = "grpc"): client = RealmsServiceClient( 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 = realms.CreateRealmRequest() # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._transport.create_realm), "__call__") as call: # Designate an appropriate return value for the call. call.return_value = operations_pb2.Operation(name="operations/spam") response = client.create_realm(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, future.Future)
def create_realm( self, request: realms.CreateRealmRequest = None, *, parent: str = None, realm: realms.Realm = None, realm_id: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation.Operation: r"""Creates a new realm in a given project and location. Args: request (:class:`~.realms.CreateRealmRequest`): The request object. Request message for RealmsService.CreateRealm. parent (:class:`str`): Required. The parent resource name. Uses the form: ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. realm (:class:`~.realms.Realm`): Required. The realm resource to be created. This corresponds to the ``realm`` field on the ``request`` instance; if ``request`` is provided, this should not be set. realm_id (:class:`str`): Required. The ID of the realm resource to be created. This corresponds to the ``realm_id`` 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: ~.operation.Operation: An object representing a long-running operation. The result type for the operation will be :class:``~.realms.Realm``: A realm resource. """ # 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([parent, realm, realm_id]) 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 realms.CreateRealmRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, realms.CreateRealmRequest): request = realms.CreateRealmRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if parent is not None: request.parent = parent if realm is not None: request.realm = realm if realm_id is not None: request.realm_id = realm_id # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.create_realm] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata( (("parent", request.parent), )), ) # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Wrap the response in an operation future. response = operation.from_gapic( response, self._transport.operations_client, realms.Realm, metadata_type=common.OperationMetadata, ) # Done; return the response. return response
async def create_realm( self, request: Union[realms.CreateRealmRequest, dict] = None, *, parent: str = None, realm: realms.Realm = None, realm_id: str = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation_async.AsyncOperation: r"""Creates a new realm in a given project and location. .. code-block:: python from google.cloud import gaming_v1 async def sample_create_realm(): # Create a client client = gaming_v1.RealmsServiceAsyncClient() # Initialize request argument(s) realm = gaming_v1.Realm() realm.time_zone = "time_zone_value" request = gaming_v1.CreateRealmRequest( parent="parent_value", realm_id="realm_id_value", realm=realm, ) # Make the request operation = client.create_realm(request=request) print("Waiting for operation to complete...") response = await operation.result() # Handle the response print(response) Args: request (Union[google.cloud.gaming_v1.types.CreateRealmRequest, dict]): The request object. Request message for RealmsService.CreateRealm. parent (:class:`str`): Required. The parent resource name, in the following form: ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. realm (:class:`google.cloud.gaming_v1.types.Realm`): Required. The realm resource to be created. This corresponds to the ``realm`` field on the ``request`` instance; if ``request`` is provided, this should not be set. realm_id (:class:`str`): Required. The ID of the realm resource to be created. This corresponds to the ``realm_id`` 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.api_core.operation_async.AsyncOperation: An object representing a long-running operation. The result type for the operation will be :class:`google.cloud.gaming_v1.types.Realm` A realm resource. """ # Create or coerce a protobuf request object. # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([parent, realm, realm_id]) 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.") request = realms.CreateRealmRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if parent is not None: request.parent = parent if realm is not None: request.realm = realm if realm_id is not None: request.realm_id = realm_id # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = gapic_v1.method_async.wrap_method( self._client._transport.create_realm, default_timeout=60.0, client_info=DEFAULT_CLIENT_INFO, ) # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata( (("parent", request.parent), )), ) # Send the request. response = await rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Wrap the response in an operation future. response = operation_async.from_gapic( response, self._client._transport.operations_client, realms.Realm, metadata_type=common.OperationMetadata, ) # Done; return the response. return response