This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.

cloudbuild

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

class pulumi_gcp.cloudbuild.Trigger(resource_name, opts=None, build=None, description=None, disabled=None, filename=None, github=None, ignored_files=None, included_files=None, name=None, project=None, substitutions=None, trigger_template=None, __props__=None, __name__=None, __opts__=None)

Configuration for an automated build in response to source repository changes.

To get more information about Trigger, see:

import pulumi
import pulumi_gcp as gcp

filename_trigger = gcp.cloudbuild.Trigger("filename-trigger",
    filename="cloudbuild.yaml",
    substitutions={
        "_BAZ": "qux",
        "_FOO": "bar",
    },
    trigger_template={
        "branchName": "master",
        "repoName": "my-repo",
    })
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • build (pulumi.Input[dict]) – Contents of the build template. Either a filename or build template must be provided. Structure is documented below.

  • description (pulumi.Input[str]) – Human-readable description of the trigger.

  • disabled (pulumi.Input[bool]) – Whether the trigger is disabled or not. If true, the trigger will never result in a build.

  • filename (pulumi.Input[str]) – Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.

  • github (pulumi.Input[dict]) – Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template or github must be provided. Structure is documented below.

  • ignored_files (pulumi.Input[list]) – ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build.

  • included_files (pulumi.Input[list]) – ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build.

  • name (pulumi.Input[str]) – Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • substitutions (pulumi.Input[dict]) – Substitutions data for Build resource.

  • trigger_template (pulumi.Input[dict]) – Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template or github must be provided. Structure is documented below.

The build object supports the following:

  • images (pulumi.Input[list]) - A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account’s credentials. The digests of the pushed images will be stored in the Build resource’s results field. If any of the images fail to be pushed, the build status is marked FAILURE.

  • steps (pulumi.Input[list]) - The operations to be performed on the workspace. Structure is documented below.

    • args (pulumi.Input[list]) - A list of arguments that will be presented to the step when it is started. If the image used to run the step’s container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.

    • dir (pulumi.Input[str]) - Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.

    • entrypoint (pulumi.Input[str]) - Entrypoint to be used instead of the build step image’s default entrypoint. If unset, the image’s default entrypoint is used

    • envs (pulumi.Input[list]) - A list of environment variable definitions to be used when running a step. The elements are of the form “KEY=VALUE” for the environment variable “KEY” being given the value “VALUE”.

    • id (pulumi.Input[str]) - Unique identifier for this build step, used in wait_for to reference this build step as a dependency.

    • name (pulumi.Input[str]) - Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

    • secretEnvs (pulumi.Input[list]) - A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build’s Secret.

    • timeout (pulumi.Input[str]) - Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

    • timing (pulumi.Input[str]) - Output only. Stores timing information for executing this build step.

    • volumes (pulumi.Input[list]) - List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below.

      • name (pulumi.Input[str]) - Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

      • path (pulumi.Input[str]) - Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

    • waitFors (pulumi.Input[list]) - The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully.

  • tags (pulumi.Input[list]) - Tags for annotation of a Build. These are not docker tags.

  • timeout (pulumi.Input[str]) - Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

The github object supports the following:

  • name (pulumi.Input[str]) - Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

  • owner (pulumi.Input[str]) - Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is “googlecloudplatform”.

  • pullRequest (pulumi.Input[dict]) - filter to match changes in pull requests. Specify only one of pullRequest or push. Structure is documented below.

    • branch (pulumi.Input[str]) - Regex of branches to match. Specify only one of branch or tag.

    • commentControl (pulumi.Input[str]) - Whether to block builds on a “/gcbrun” comment from a repository owner or collaborator.

    • invertRegex (pulumi.Input[bool]) - When true, only trigger a build if the revision regex does NOT match the git_ref regex.

  • push (pulumi.Input[dict]) - filter to match changes in refs, like branches or tags. Specify only one of pullRequest or push. Structure is documented below.

    • branch (pulumi.Input[str]) - Regex of branches to match. Specify only one of branch or tag.

    • invertRegex (pulumi.Input[bool]) - When true, only trigger a build if the revision regex does NOT match the git_ref regex.

    • tag (pulumi.Input[str]) - Regex of tags to match. Specify only one of branch or tag.

The trigger_template object supports the following:

  • branchName (pulumi.Input[str]) - Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression.

  • commitSha (pulumi.Input[str]) - Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided.

  • dir (pulumi.Input[str]) - Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.

  • invertRegex (pulumi.Input[bool]) - When true, only trigger a build if the revision regex does NOT match the git_ref regex.

  • project_id (pulumi.Input[str]) - ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.

  • repoName (pulumi.Input[str]) - Name of the Cloud Source Repository. If omitted, the name “default” is assumed.

  • tagName (pulumi.Input[str]) - Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression.

build: pulumi.Output[dict] = None

Contents of the build template. Either a filename or build template must be provided. Structure is documented below.

  • images (list) - A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account’s credentials. The digests of the pushed images will be stored in the Build resource’s results field. If any of the images fail to be pushed, the build status is marked FAILURE.

  • steps (list) - The operations to be performed on the workspace. Structure is documented below.

    • args (list) - A list of arguments that will be presented to the step when it is started. If the image used to run the step’s container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.

    • dir (str) - Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.

    • entrypoint (str) - Entrypoint to be used instead of the build step image’s default entrypoint. If unset, the image’s default entrypoint is used

    • envs (list) - A list of environment variable definitions to be used when running a step. The elements are of the form “KEY=VALUE” for the environment variable “KEY” being given the value “VALUE”.

    • id (str) - Unique identifier for this build step, used in wait_for to reference this build step as a dependency.

    • name (str) - Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

    • secretEnvs (list) - A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build’s Secret.

    • timeout (str) - Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

    • timing (str) - Output only. Stores timing information for executing this build step.

    • volumes (list) - List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below.

      • name (str) - Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

      • path (str) - Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

    • waitFors (list) - The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully.

  • tags (list) - Tags for annotation of a Build. These are not docker tags.

  • timeout (str) - Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

create_time: pulumi.Output[str] = None

Time when the trigger was created.

description: pulumi.Output[str] = None

Human-readable description of the trigger.

disabled: pulumi.Output[bool] = None

Whether the trigger is disabled or not. If true, the trigger will never result in a build.

filename: pulumi.Output[str] = None

Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.

github: pulumi.Output[dict] = None

Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template or github must be provided. Structure is documented below.

  • name (str) - Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

  • owner (str) - Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is “googlecloudplatform”.

  • pullRequest (dict) - filter to match changes in pull requests. Specify only one of pullRequest or push. Structure is documented below.

    • branch (str) - Regex of branches to match. Specify only one of branch or tag.

    • commentControl (str) - Whether to block builds on a “/gcbrun” comment from a repository owner or collaborator.

    • invertRegex (bool) - When true, only trigger a build if the revision regex does NOT match the git_ref regex.

  • push (dict) - filter to match changes in refs, like branches or tags. Specify only one of pullRequest or push. Structure is documented below.

    • branch (str) - Regex of branches to match. Specify only one of branch or tag.

    • invertRegex (bool) - When true, only trigger a build if the revision regex does NOT match the git_ref regex.

    • tag (str) - Regex of tags to match. Specify only one of branch or tag.

ignored_files: pulumi.Output[list] = None

ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build.

included_files: pulumi.Output[list] = None

ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build.

name: pulumi.Output[str] = None

Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

project: pulumi.Output[str] = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

substitutions: pulumi.Output[dict] = None

Substitutions data for Build resource.

trigger_id: pulumi.Output[str] = None

The unique identifier for the trigger.

trigger_template: pulumi.Output[dict] = None

Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template or github must be provided. Structure is documented below.

  • branchName (str) - Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression.

  • commitSha (str) - Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided.

  • dir (str) - Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.

  • invertRegex (bool) - When true, only trigger a build if the revision regex does NOT match the git_ref regex.

  • project_id (str) - ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.

  • repoName (str) - Name of the Cloud Source Repository. If omitted, the name “default” is assumed.

  • tagName (str) - Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression.

static get(resource_name, id, opts=None, build=None, create_time=None, description=None, disabled=None, filename=None, github=None, ignored_files=None, included_files=None, name=None, project=None, substitutions=None, trigger_id=None, trigger_template=None)

Get an existing Trigger resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • build (pulumi.Input[dict]) – Contents of the build template. Either a filename or build template must be provided. Structure is documented below.

  • create_time (pulumi.Input[str]) – Time when the trigger was created.

  • description (pulumi.Input[str]) – Human-readable description of the trigger.

  • disabled (pulumi.Input[bool]) – Whether the trigger is disabled or not. If true, the trigger will never result in a build.

  • filename (pulumi.Input[str]) – Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.

  • github (pulumi.Input[dict]) – Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template or github must be provided. Structure is documented below.

  • ignored_files (pulumi.Input[list]) – ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build.

  • included_files (pulumi.Input[list]) – ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build.

  • name (pulumi.Input[str]) – Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • substitutions (pulumi.Input[dict]) – Substitutions data for Build resource.

  • trigger_id (pulumi.Input[str]) – The unique identifier for the trigger.

  • trigger_template (pulumi.Input[dict]) – Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template or github must be provided. Structure is documented below.

The build object supports the following:

  • images (pulumi.Input[list]) - A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account’s credentials. The digests of the pushed images will be stored in the Build resource’s results field. If any of the images fail to be pushed, the build status is marked FAILURE.

  • steps (pulumi.Input[list]) - The operations to be performed on the workspace. Structure is documented below.

    • args (pulumi.Input[list]) - A list of arguments that will be presented to the step when it is started. If the image used to run the step’s container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.

    • dir (pulumi.Input[str]) - Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.

    • entrypoint (pulumi.Input[str]) - Entrypoint to be used instead of the build step image’s default entrypoint. If unset, the image’s default entrypoint is used

    • envs (pulumi.Input[list]) - A list of environment variable definitions to be used when running a step. The elements are of the form “KEY=VALUE” for the environment variable “KEY” being given the value “VALUE”.

    • id (pulumi.Input[str]) - Unique identifier for this build step, used in wait_for to reference this build step as a dependency.

    • name (pulumi.Input[str]) - Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

    • secretEnvs (pulumi.Input[list]) - A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build’s Secret.

    • timeout (pulumi.Input[str]) - Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

    • timing (pulumi.Input[str]) - Output only. Stores timing information for executing this build step.

    • volumes (pulumi.Input[list]) - List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below.

      • name (pulumi.Input[str]) - Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

      • path (pulumi.Input[str]) - Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

    • waitFors (pulumi.Input[list]) - The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully.

  • tags (pulumi.Input[list]) - Tags for annotation of a Build. These are not docker tags.

  • timeout (pulumi.Input[str]) - Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

The github object supports the following:

  • name (pulumi.Input[str]) - Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

  • owner (pulumi.Input[str]) - Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is “googlecloudplatform”.

  • pullRequest (pulumi.Input[dict]) - filter to match changes in pull requests. Specify only one of pullRequest or push. Structure is documented below.

    • branch (pulumi.Input[str]) - Regex of branches to match. Specify only one of branch or tag.

    • commentControl (pulumi.Input[str]) - Whether to block builds on a “/gcbrun” comment from a repository owner or collaborator.

    • invertRegex (pulumi.Input[bool]) - When true, only trigger a build if the revision regex does NOT match the git_ref regex.

  • push (pulumi.Input[dict]) - filter to match changes in refs, like branches or tags. Specify only one of pullRequest or push. Structure is documented below.

    • branch (pulumi.Input[str]) - Regex of branches to match. Specify only one of branch or tag.

    • invertRegex (pulumi.Input[bool]) - When true, only trigger a build if the revision regex does NOT match the git_ref regex.

    • tag (pulumi.Input[str]) - Regex of tags to match. Specify only one of branch or tag.

The trigger_template object supports the following:

  • branchName (pulumi.Input[str]) - Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression.

  • commitSha (pulumi.Input[str]) - Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided.

  • dir (pulumi.Input[str]) - Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.

  • invertRegex (pulumi.Input[bool]) - When true, only trigger a build if the revision regex does NOT match the git_ref regex.

  • project_id (pulumi.Input[str]) - ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.

  • repoName (pulumi.Input[str]) - Name of the Cloud Source Repository. If omitted, the name “default” is assumed.

  • tagName (pulumi.Input[str]) - Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str