Repository class

A repository (or repo) is a Git repository storing versioned source content.

To get more information about Repository, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Sourcerepo Repository Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const my_repo = new gcp.sourcerepo.Repository("my-repo", {name: "my/repository"});

import pulumi
import pulumi_gcp as gcp

my_repo = gcp.sourcerepo.Repository("my-repo", name="my/repository")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var my_repo = new Gcp.SourceRepo.Repository("my-repo", new()
    {
        Name = "my/repository",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/sourcerepo"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sourcerepo.NewRepository(ctx, "my-repo", &sourcerepo.RepositoryArgs{
			Name: pulumi.String("my/repository"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_sourcerepo_repository" "my-repo" {
  name = "my/repository"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.sourcerepo.Repository;
import com.pulumi.gcp.sourcerepo.RepositoryArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var my_repo = new Repository("my-repo", RepositoryArgs.builder()
            .name("my/repository")
            .build());

    }
}

resources:
  my-repo:
    type: gcp:sourcerepo:Repository
    properties:
      name: my/repository

Sourcerepo Repository Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const testAccount = new gcp.serviceaccount.Account("test_account", {
    accountId: "my-account",
    displayName: "Test Service Account",
});
const topic = new gcp.pubsub.Topic("topic", {name: "my-topic"});
const my_repo = new gcp.sourcerepo.Repository("my-repo", {
    name: "my-repository",
    pubsubConfigs: [{
        topic: topic.id,
        messageFormat: "JSON",
        serviceAccountEmail: testAccount.email,
    }],
});

import pulumi
import pulumi_gcp as gcp

test_account = gcp.serviceaccount.Account("test_account",
    account_id="my-account",
    display_name="Test Service Account")
topic = gcp.pubsub.Topic("topic", name="my-topic")
my_repo = gcp.sourcerepo.Repository("my-repo",
    name="my-repository",
    pubsub_configs=[{
        "topic": topic.id,
        "message_format": "JSON",
        "service_account_email": test_account.email,
    }])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var testAccount = new Gcp.ServiceAccount.Account("test_account", new()
    {
        AccountId = "my-account",
        DisplayName = "Test Service Account",
    });

    var topic = new Gcp.PubSub.Topic("topic", new()
    {
        Name = "my-topic",
    });

    var my_repo = new Gcp.SourceRepo.Repository("my-repo", new()
    {
        Name = "my-repository",
        PubsubConfigs = new[]
        {
            new Gcp.SourceRepo.Inputs.RepositoryPubsubConfigArgs
            {
                Topic = topic.Id,
                MessageFormat = "JSON",
                ServiceAccountEmail = testAccount.Email,
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/pubsub"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/serviceaccount"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/sourcerepo"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testAccount, err := serviceaccount.NewAccount(ctx, "test_account", &serviceaccount.AccountArgs{
			AccountId:   pulumi.String("my-account"),
			DisplayName: pulumi.String("Test Service Account"),
		})
		if err != nil {
			return err
		}
		topic, err := pubsub.NewTopic(ctx, "topic", &pubsub.TopicArgs{
			Name: pulumi.String("my-topic"),
		})
		if err != nil {
			return err
		}
		_, err = sourcerepo.NewRepository(ctx, "my-repo", &sourcerepo.RepositoryArgs{
			Name: pulumi.String("my-repository"),
			PubsubConfigs: sourcerepo.RepositoryPubsubConfigArray{
				&sourcerepo.RepositoryPubsubConfigArgs{
					Topic:               topic.ID().ToIDOutput().ToStringOutput(),
					MessageFormat:       pulumi.String("JSON"),
					ServiceAccountEmail: testAccount.Email,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_serviceaccount_account" "test_account" {
  account_id   = "my-account"
  display_name = "Test Service Account"
}
resource "gcp_pubsub_topic" "topic" {
  name = "my-topic"
}
resource "gcp_sourcerepo_repository" "my-repo" {
  name = "my-repository"
  pubsub_configs {
    topic                 = gcp_pubsub_topic.topic.id
    message_format        = "JSON"
    service_account_email = gcp_serviceaccount_account.test_account.email
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.serviceaccount.Account;
import com.pulumi.gcp.serviceaccount.AccountArgs;
import com.pulumi.gcp.pubsub.Topic;
import com.pulumi.gcp.pubsub.TopicArgs;
import com.pulumi.gcp.sourcerepo.Repository;
import com.pulumi.gcp.sourcerepo.RepositoryArgs;
import com.pulumi.gcp.sourcerepo.inputs.RepositoryPubsubConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testAccount = new Account("testAccount", AccountArgs.builder()
            .accountId("my-account")
            .displayName("Test Service Account")
            .build());

        var topic = new Topic("topic", TopicArgs.builder()
            .name("my-topic")
            .build());

        var my_repo = new Repository("my-repo", RepositoryArgs.builder()
            .name("my-repository")
            .pubsubConfigs(RepositoryPubsubConfigArgs.builder()
                .topic(topic.id())
                .messageFormat("JSON")
                .serviceAccountEmail(testAccount.email())
                .build())
            .build());

    }
}

resources:
  testAccount:
    type: gcp:serviceaccount:Account
    name: test_account
    properties:
      accountId: my-account
      displayName: Test Service Account
  topic:
    type: gcp:pubsub:Topic
    properties:
      name: my-topic
  my-repo:
    type: gcp:sourcerepo:Repository
    properties:
      name: my-repository
      pubsubConfigs:
        - topic: ${topic.id}
          messageFormat: JSON
          serviceAccountEmail: ${testAccount.email}

Import

Repository can be imported using any of these accepted formats:

• projects/{{project}}/repos/{{name}}
• {{name}}

When using the pulumi import command, Repository can be imported using one of the formats above. For example:

$ pulumi import gcp:sourcerepo/repository:Repository default projects/{{project}}/repos/{{name}}
$ pulumi import gcp:sourcerepo/repository:Repository default {{name}}

Constructors

Repository(String name, {RepositoryArgs? args, CustomResourceOptions? options})

Creates a new Repository. name The Pulumi resource name. args Arguments used to configure this Repository. The set of arguments for Repository. options Resource options controlling this resource's behavior.

Repository.reference(String urn)

Creates a typed reference to an existing Repository resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createIgnoreAlreadyExists ↔ Output<bool?>

If set to true, skip repository creation if a repository with the same name already exists.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

Resource name of the repository, of the form {{repo}}. The repo name may contain slashes. eg, name/with/slash

late, final

project ↔ Output<String>

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

late, final

pubsubConfigs ↔ Output<List<RepositoryPubsubConfig>?>

How this repository publishes a change in the repository through Cloud Pub/Sub. Keyed by the topic names. Structure is documented below.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

size ↔ Output<int>

The disk usage of the repo, in bytes.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

url ↔ Output<String>

URL to clone the repository from Google Cloud Source Repositories.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {RepositoryState? state, CustomResourceOptions? options}) → Repository

Gets an existing Repository resource's state with the given name and id.