async def get_monitored_resource_descriptor( self, request: metric_service.GetMonitoredResourceDescriptorRequest = None, *, name: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> monitored_resource_pb2.MonitoredResourceDescriptor: r"""Gets a single monitored resource descriptor. This method does not require a Workspace. Args: request (:class:`google.cloud.monitoring_v3.types.GetMonitoredResourceDescriptorRequest`): The request object. The `GetMonitoredResourceDescriptor` request. name (:class:`str`): Required. The monitored resource descriptor to get. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] The ``[RESOURCE_TYPE]`` is a predefined type, such as ``cloudsql_database``. 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: google.api.monitored_resource_pb2.MonitoredResourceDescriptor: An object that describes the schema of a [MonitoredResource][google.api.MonitoredResource] object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API. """ # 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([name]) 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 = metric_service.GetMonitoredResourceDescriptorRequest(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_async.wrap_method( self._client._transport.get_monitored_resource_descriptor, default_retry=retries.Retry( initial=0.1, maximum=30.0, multiplier=1.3, predicate=retries.if_exception_type( core_exceptions.DeadlineExceeded, core_exceptions.ServiceUnavailable, ), deadline=30.0, ), default_timeout=30.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( (("name", request.name), )), ) # Send the request. response = await rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
def get_monitored_resource_descriptor( self, request: metric_service.GetMonitoredResourceDescriptorRequest = None, *, name: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> monitored_resource.MonitoredResourceDescriptor: r"""Gets a single monitored resource descriptor. This method does not require a Workspace. Args: request (:class:`~.metric_service.GetMonitoredResourceDescriptorRequest`): The request object. The `GetMonitoredResourceDescriptor` request. name (:class:`str`): Required. The monitored resource descriptor to get. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] The ``[RESOURCE_TYPE]`` is a predefined type, such as ``cloudsql_database``. 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: ~.monitored_resource.MonitoredResourceDescriptor: An object that describes the schema of a [MonitoredResource][google.api.MonitoredResource] object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of ``"gce_instance"`` and specifies the use of the labels ``"instance_id"`` and ``"zone"`` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a ``list`` method that returns the monitored resource descriptors used by the API. """ # 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([name]) 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 metric_service.GetMonitoredResourceDescriptorRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance( request, metric_service.GetMonitoredResourceDescriptorRequest): request = metric_service.GetMonitoredResourceDescriptorRequest( 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 = self._transport._wrapped_methods[ self._transport.get_monitored_resource_descriptor] # 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
async def get_monitored_resource_descriptor( self, request: metric_service.GetMonitoredResourceDescriptorRequest = None, *, name: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> monitored_resource.MonitoredResourceDescriptor: r"""Gets a single monitored resource descriptor. This method does not require a Workspace. Args: request (:class:`~.metric_service.GetMonitoredResourceDescriptorRequest`): The request object. The `GetMonitoredResourceDescriptor` request. name (:class:`str`): Required. The monitored resource descriptor to get. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] The ``[RESOURCE_TYPE]`` is a predefined type, such as ``cloudsql_database``. 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: ~.monitored_resource.MonitoredResourceDescriptor: An object that describes the schema of a [MonitoredResource][google.api.MonitoredResource] object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of ``"gce_instance"`` and specifies the use of the labels ``"instance_id"`` and ``"zone"`` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: - The ``type``, ``display_name``, ``description``, ``labels`` and ``launch_stage`` fields are all required. - The first label of the monitored resource descriptor must be ``resource_container``. There are legacy monitored resource descritptors start with ``project_id``. - It must include a ``location`` label. - Maximum of default 5 service defined monitored resource descriptors is allowed per service. - Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas """ # 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 = metric_service.GetMonitoredResourceDescriptorRequest(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_async.wrap_method( self._client._transport.get_monitored_resource_descriptor, default_retry=retries.Retry( initial=0.1, maximum=30.0, multiplier=1.3, predicate=retries.if_exception_type( exceptions.DeadlineExceeded, exceptions.ServiceUnavailable, ), ), default_timeout=30.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( (("name", request.name), )), ) # Send the request. response = await rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response