Resource interface
Stay organized with collections
Save and categorize content based on your preferences.
Resource is a standard format for defining a resource (google.rpc.context.AttributeContext.Resource). In Cloud Functions, it is the resource that triggered the function - such as a storage bucket.
Signature:
export interface Resource
Properties
Property |
Type |
Description |
labels |
{ [tag: string]: string; } |
Map of Resource's labels. |
name |
string |
The stable identifier (name) of a resource on the service. A resource can be logically identified as "//{resource.service}/{resource.name}" |
service |
string |
The name of the service that this resource belongs to. |
type |
string |
The type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be "{service}/{kind}" |
Resource.labels
Map of Resource's labels.
Signature:
labels?: {
[tag: string]: string;
};
Resource.name
The stable identifier (name) of a resource on the service. A resource can be logically identified as "//{resource.service}/{resource.name}"
Signature:
name: string;
Resource.service
The name of the service that this resource belongs to.
Signature:
service: string;
Resource.type
The type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be "{service}/{kind}"
Signature:
type?: string;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-09-13 UTC.
[null,null,["Last updated 2022-09-13 UTC."],[],[],null,["# Resource interface\n\nResource is a standard format for defining a resource (google.rpc.context.AttributeContext.Resource). In Cloud Functions, it is the resource that triggered the function - such as a storage bucket.\n\n**Signature:** \n\n export interface Resource \n\nProperties\n----------\n\n| Property | Type | Description |\n|-------------------------------------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [labels](./firebase-functions.resource.md#resourcelabels) | { \\[tag: string\\]: string; } | Map of Resource's labels. |\n| [name](./firebase-functions.resource.md#resourcename) | string | The stable identifier (name) of a resource on the service. A resource can be logically identified as \"//{resource.service}/{resource.name}\" |\n| [service](./firebase-functions.resource.md#resourceservice) | string | The name of the service that this resource belongs to. |\n| [type](./firebase-functions.resource.md#resourcetype) | string | The type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be \"{service}/{kind}\" |\n\nResource.labels\n---------------\n\nMap of Resource's labels.\n\n**Signature:** \n\n labels?: {\n [tag: string]: string;\n };\n\nResource.name\n-------------\n\nThe stable identifier (name) of a resource on the service. A resource can be logically identified as \"//{resource.service}/{resource.name}\"\n\n**Signature:** \n\n name: string;\n\nResource.service\n----------------\n\nThe name of the service that this resource belongs to.\n\n**Signature:** \n\n service: string;\n\nResource.type\n-------------\n\nThe type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be \"{service}/{kind}\"\n\n**Signature:** \n\n type?: string;"]]