Constructor
new AssetServiceClient(optionsopt)
Construct an instance of AssetServiceClient.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
Members
apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
close() → {Promise}
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves when the client is closed. |
createFeed(request, optionsopt) → {Promise}
Creates a feed in a parent project/folder/organization to listen to its asset updates.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Promise |
|
deleteFeed(request, optionsopt) → {Promise}
Deletes an asset feed.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Promise |
|
folderFeedPath(folder, feed) → {string}
Return a fully-qualified folderFeed resource name string.
Parameters:
Name | Type | Description |
---|---|---|
folder |
string | |
feed |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
getFeed(request, optionsopt) → {Promise}
Gets details about an asset feed.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Promise |
|
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
initialize() → {Promise}
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to an authenticated service stub. |
listFeeds(request, optionsopt) → {Promise}
Lists all asset feeds in a parent project/folder/organization.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Promise |
|
matchFeedFromFolderFeedName(folderFeedName) → {string}
Parse the feed from FolderFeed resource.
Parameters:
Name | Type | Description |
---|---|---|
folderFeedName |
string |
A fully-qualified path representing folder_feed resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the feed. |
matchFeedFromOrganizationFeedName(organizationFeedName) → {string}
Parse the feed from OrganizationFeed resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationFeedName |
string |
A fully-qualified path representing organization_feed resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the feed. |
matchFeedFromProjectFeedName(projectFeedName) → {string}
Parse the feed from ProjectFeed resource.
Parameters:
Name | Type | Description |
---|---|---|
projectFeedName |
string |
A fully-qualified path representing project_feed resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the feed. |
matchFolderFromFolderFeedName(folderFeedName) → {string}
Parse the folder from FolderFeed resource.
Parameters:
Name | Type | Description |
---|---|---|
folderFeedName |
string |
A fully-qualified path representing folder_feed resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the folder. |
matchOrganizationFromOrganizationFeedName(organizationFeedName) → {string}
Parse the organization from OrganizationFeed resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationFeedName |
string |
A fully-qualified path representing organization_feed resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the organization. |
matchProjectFromProjectFeedName(projectFeedName) → {string}
Parse the project from ProjectFeed resource.
Parameters:
Name | Type | Description |
---|---|---|
projectFeedName |
string |
A fully-qualified path representing project_feed resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
organizationFeedPath(organization, feed) → {string}
Return a fully-qualified organizationFeed resource name string.
Parameters:
Name | Type | Description |
---|---|---|
organization |
string | |
feed |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectFeedPath(project, feed) → {string}
Return a fully-qualified projectFeed resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
feed |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
updateFeed(request, optionsopt) → {Promise}
Updates an asset feed configuration.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Promise |
|