Google Cloud Eventarc V1 Client - Class EventarcClient (1.2.2)

Version 1.2.2

• 2.1.3 (latest)
• 2.1.2
• 2.0.1
• 1.3.5
• 1.2.2
• 1.1.1
• 1.0.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Eventarc V1 Client class EventarcClient.

Service Description: Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\Eventarc\V1\EventarcClient for the stable implementation

Namespace

Google \ Cloud \ Eventarc \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createChannel

Create a new channel in a particular project and location.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::createChannelAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\CreateChannelRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createChannelConnection

Create a new ChannelConnection in a particular project and location.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::createChannelConnectionAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\CreateChannelConnectionRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createTrigger

Create a new trigger in a particular project and location.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::createTriggerAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\CreateTriggerRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteChannel

Delete a single channel.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::deleteChannelAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\DeleteChannelRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteChannelConnection

Delete a single ChannelConnection.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::deleteChannelConnectionAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\DeleteChannelConnectionRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteTrigger

Delete a single trigger.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::deleteTriggerAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\DeleteTriggerRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

getChannel

Get a single Channel.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::getChannelAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\GetChannelRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Eventarc\V1\Channel

getChannelConnection

Get a single ChannelConnection.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::getChannelConnectionAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\GetChannelConnectionRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Eventarc\V1\ChannelConnection

getGoogleChannelConfig

Get a GoogleChannelConfig

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::getGoogleChannelConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\GetGoogleChannelConfigRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Eventarc\V1\GoogleChannelConfig

getProvider

Get a single Provider.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::getProviderAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\GetProviderRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Eventarc\V1\Provider

getTrigger

Get a single trigger.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::getTriggerAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\GetTriggerRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Eventarc\V1\Trigger

listChannelConnections

List channel connections.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::listChannelConnectionsAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\ListChannelConnectionsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listChannels

List channels.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::listChannelsAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\ListChannelsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listProviders

List providers.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::listProvidersAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\ListProvidersRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listTriggers

List triggers.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::listTriggersAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\ListTriggersRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

updateChannel

Update a single channel.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::updateChannelAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\UpdateChannelRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateGoogleChannelConfig

Update a single GoogleChannelConfig

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::updateGoogleChannelConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\UpdateGoogleChannelConfigRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Eventarc\V1\GoogleChannelConfig

updateTrigger

Update a single trigger.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::updateTriggerAsync() .

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\UpdateTriggerRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

getLocation

Gets information about a location.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::getLocationAsync() .

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Location\Location

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::listLocationsAsync() .

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::getIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\Policy

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::setIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\Policy

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

The async variant is Google\Cloud\Eventarc\V1\Client\EventarcClient::testIamPermissionsAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\TestIamPermissionsResponse

createChannelAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\CreateChannelRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createChannelConnectionAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\CreateChannelConnectionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createTriggerAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\CreateTriggerRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteChannelAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\DeleteChannelRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteChannelConnectionAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\DeleteChannelConnectionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteTriggerAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\DeleteTriggerRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getChannelAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\GetChannelRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getChannelConnectionAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\GetChannelConnectionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getGoogleChannelConfigAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\GetGoogleChannelConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getProviderAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\GetProviderRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getTriggerAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\GetTriggerRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listChannelConnectionsAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\ListChannelConnectionsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listChannelsAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\ListChannelsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listProvidersAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\ListProvidersRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listTriggersAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\ListTriggersRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateChannelAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\UpdateChannelRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateGoogleChannelConfigAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\UpdateGoogleChannelConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateTriggerAsync

Parameters
Name	Description
request	Google\Cloud\Eventarc\V1\UpdateTriggerRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getLocationAsync

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listLocationsAsync

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

testIamPermissionsAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
operationName	string The name of the long running operation
methodName	string The name of the method used to start the operation

Returns
Type	Description
Google\ApiCore\OperationResponse

static::channelName

Formats a string containing the fully-qualified path to represent a channel resource.

Parameters
Name	Description
project	string
location	string
channel	string

Returns
Type	Description
string	The formatted channel resource.

static::channelConnectionName

Formats a string containing the fully-qualified path to represent a channel_connection resource.

Parameters
Name	Description
project	string
location	string
channelConnection	string

Returns
Type	Description
string	The formatted channel_connection resource.

static::cloudFunctionName

Formats a string containing the fully-qualified path to represent a cloud_function resource.

Parameters
Name	Description
project	string
location	string
function	string

Returns
Type	Description
string	The formatted cloud_function resource.

static::cryptoKeyName

Formats a string containing the fully-qualified path to represent a crypto_key resource.

Parameters
Name	Description
project	string
location	string
keyRing	string
cryptoKey	string

Returns
Type	Description
string	The formatted crypto_key resource.

static::googleChannelConfigName

Formats a string containing the fully-qualified path to represent a google_channel_config resource.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	The formatted google_channel_config resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	The formatted location resource.

static::providerName

Formats a string containing the fully-qualified path to represent a provider resource.

Parameters
Name	Description
project	string
location	string
provider	string

Returns
Type	Description
string	The formatted provider resource.

static::serviceAccountName

Formats a string containing the fully-qualified path to represent a service_account resource.

Parameters
Name	Description
project	string
serviceAccount	string

Returns
Type	Description
string	The formatted service_account resource.

static::triggerName

Formats a string containing the fully-qualified path to represent a trigger resource.

Parameters
Name	Description
project	string
location	string
trigger	string

Returns
Type	Description
string	The formatted trigger resource.

static::workflowName

Formats a string containing the fully-qualified path to represent a workflow resource.

Parameters
Name	Description
project	string
location	string
workflow	string

Returns
Type	Description
string	The formatted workflow resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• channel: projects/{project}/locations/{location}/channels/{channel}
• channelConnection: projects/{project}/locations/{location}/channelConnections/{channel_connection}
• cloudFunction: projects/{project}/locations/{location}/functions/{function}
• cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
• googleChannelConfig: projects/{project}/locations/{location}/googleChannelConfig
• location: projects/{project}/locations/{location}
• provider: projects/{project}/locations/{location}/providers/{provider}
• serviceAccount: projects/{project}/serviceAccounts/{service_account}
• trigger: projects/{project}/locations/{location}/triggers/{trigger}
• workflow: projects/{project}/locations/{location}/workflows/{workflow}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.