Service class

An individual service. A service contains a name and optional metadata.

To get more information about Service, see:

Example Usage

Service Directory Service Basic

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

const example = new gcp.servicedirectory.Namespace("example", {
    namespaceId: "example-namespace",
    location: "us-central1",
});
const exampleService = new gcp.servicedirectory.Service("example", {
    serviceId: "example-service",
    namespace: example.id,
    metadata: {
        stage: "prod",
        region: "us-central1",
    },
});

import pulumi
import pulumi_gcp as gcp

example = gcp.servicedirectory.Namespace("example",
    namespace_id="example-namespace",
    location="us-central1")
example_service = gcp.servicedirectory.Service("example",
    service_id="example-service",
    namespace=example.id,
    metadata={
        "stage": "prod",
        "region": "us-central1",
    })

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

return await Deployment.RunAsync(() =>
{
    var example = new Gcp.ServiceDirectory.Namespace("example", new()
    {
        NamespaceId = "example-namespace",
        Location = "us-central1",
    });

    var exampleService = new Gcp.ServiceDirectory.Service("example", new()
    {
        ServiceId = "example-service",
        Namespace = example.Id,
        Metadata =
        {
            { "stage", "prod" },
            { "region", "us-central1" },
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := servicedirectory.NewNamespace(ctx, "example", &servicedirectory.NamespaceArgs{
			NamespaceId: pulumi.String("example-namespace"),
			Location:    pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		_, err = servicedirectory.NewService(ctx, "example", &servicedirectory.ServiceArgs{
			ServiceId: pulumi.String("example-service"),
			Namespace: example.ID().ToIDOutput().ToStringOutput(),
			Metadata: pulumi.StringMap{
				"stage":  pulumi.String("prod"),
				"region": pulumi.String("us-central1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_servicedirectory_namespace" "example" {
  namespace_id = "example-namespace"
  location     = "us-central1"
}
resource "gcp_servicedirectory_service" "example" {
  service_id = "example-service"
  namespace  = gcp_servicedirectory_namespace.example.id
  metadata = {
    "stage"  = "prod"
    "region" = "us-central1"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.servicedirectory.Namespace;
import com.pulumi.gcp.servicedirectory.NamespaceArgs;
import com.pulumi.gcp.servicedirectory.Service;
import com.pulumi.gcp.servicedirectory.ServiceArgs;
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 example = new Namespace("example", NamespaceArgs.builder()
            .namespaceId("example-namespace")
            .location("us-central1")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .serviceId("example-service")
            .namespace(example.id())
            .metadata(Map.ofEntries(
                Map.entry("stage", "prod"),
                Map.entry("region", "us-central1")
            ))
            .build());

    }
}

resources:
  example:
    type: gcp:servicedirectory:Namespace
    properties:
      namespaceId: example-namespace
      location: us-central1
  exampleService:
    type: gcp:servicedirectory:Service
    name: example
    properties:
      serviceId: example-service
      namespace: ${example.id}
      metadata:
        stage: prod
        region: us-central1

Import

Service can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/namespaces/{{namespace_id}}/services/{{service_id}}
{{project}}/{{location}}/{{namespace_id}}/{{service_id}}
{{location}}/{{namespace_id}}/{{service_id}}

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

$ pulumi import gcp:servicedirectory/service:Service default projects/{{project}}/locations/{{location}}/namespaces/{{namespace_id}}/services/{{service_id}}
$ pulumi import gcp:servicedirectory/service:Service default {{project}}/{{location}}/{{namespace_id}}/{{service_id}}
$ pulumi import gcp:servicedirectory/service:Service default {{location}}/{{namespace_id}}/{{service_id}}

Constructors

Service(String name, {ServiceArgs? args, CustomResourceOptions? options}): Creates a new Service. name The Pulumi resource name. args Arguments used to configure this Service. The set of arguments for Service. options Resource options controlling this resource's behavior.
Service.reference(String urn): Creates a typed reference to an existing Service resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
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.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
metadata ↔ Output<Map<String, String>?>: Metadata for the service. This data can be consumed by service clients. The entire metadata dictionary may contain up to 2000 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
latefinal
name ↔ Output<String>: The resource name for the service in the format projects/*/locations/*/namespaces/*/services/*.
latefinal
namespace ↔ Output<String>: The resource name of the namespace this service will belong to.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
serviceId ↔ Output<String>: The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

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, {ServiceState? state, CustomResourceOptions? options}) → Service: Gets an existing Service resource's state with the given name and id.