Class Endpoint

An individual endpoint that provides a service.

To get more information about Endpoint, see:

• API documentation
• How-to Guides
• Configuring an endpoint

Example Usage - Service Directory Endpoint Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var exampleNamespace = new Gcp.ServiceDirectory.Namespace("exampleNamespace", new Gcp.ServiceDirectory.NamespaceArgs
    {
        NamespaceId = "example-namespace",
        Location = "us-central1",
    });
    var exampleService = new Gcp.ServiceDirectory.Service("exampleService", new Gcp.ServiceDirectory.ServiceArgs
    {
        ServiceId = "example-service",
        Namespace = exampleNamespace.Id,
    });
    var exampleEndpoint = new Gcp.ServiceDirectory.Endpoint("exampleEndpoint", new Gcp.ServiceDirectory.EndpointArgs
    {
        EndpointId = "example-endpoint",
        Service = exampleService.Id,
        Metadata = 
        {
            { "stage", "prod" },
            { "region", "us-central1" },
        },
        Address = "1.2.3.4",
        Port = 5353,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Endpoint

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.ServiceDirectory

Assembly: Pulumi.Gcp.dll

Syntax

public class Endpoint : CustomResource

Constructors

Endpoint(String, EndpointArgs, CustomResourceOptions)

Create a Endpoint resource with the given unique name, arguments, and options.

Declaration

public Endpoint(string name, EndpointArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EndpointArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Address

IPv4 or IPv6 address of the endpoint.

Declaration

public Output<string> Address { get; }

Property Value

Type	Description
Output<System.String>

EndpointId

The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.

Declaration

public Output<string> EndpointId { get; }

Property Value

Type	Description
Output<System.String>

Metadata

Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.

Declaration

public Output<ImmutableDictionary<string, string>> Metadata { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Name

The resource name for the endpoint in the format 'projects//locations//namespaces//services//endpoints/*'.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Port

Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.

Declaration

public Output<int?> Port { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Service

The resource name of the service that this endpoint provides.

Declaration

public Output<string> Service { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, EndpointState, CustomResourceOptions)

Get an existing Endpoint resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Endpoint Get(string name, Input<string> id, EndpointState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EndpointState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Endpoint