Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource

The "connectors" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.ManagedKafka.v1
Assembly: Google.Apis.ManagedKafka.v1.dll
Syntax
public class ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource

Constructors

ConnectorsResource(IClientService)

Constructs a new resource.

Declaration
public ConnectorsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(Connector, string)

Creates a new connector in a given Connect cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.CreateRequest Create(Connector body, string parent)
Parameters
Type Name Description
Connector body

The body of the request.

string parent

Required. The parent Connect cluster in which to create the connector. Structured like projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}.

Returns
Type Description
ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.CreateRequest

Delete(string)

Deletes a connector.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The name of the connector to delete. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

Returns
Type Description
ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.DeleteRequest

Get(string)

Returns the properties of a single connector.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The name of the connector whose configuration to return. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

Returns
Type Description
ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.GetRequest

List(string)

Lists the connectors in a given Connect cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The parent Connect cluster whose connectors are to be listed. Structured like projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}.

Returns
Type Description
ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.ListRequest

Patch(Connector, string)

Updates the properties of a connector.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.PatchRequest Patch(Connector body, string name)
Parameters
Type Name Description
Connector body

The body of the request.

string name

Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}

Returns
Type Description
ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.PatchRequest

Pause(PauseConnectorRequest, string)

Pauses the connector and its tasks.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.PauseRequest Pause(PauseConnectorRequest body, string name)
Parameters
Type Name Description
PauseConnectorRequest body

The body of the request.

string name

Required. The name of the connector to pause. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

Returns
Type Description
ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.PauseRequest

Restart(RestartConnectorRequest, string)

Restarts the connector.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.RestartRequest Restart(RestartConnectorRequest body, string name)
Parameters
Type Name Description
RestartConnectorRequest body

The body of the request.

string name

Required. The name of the connector to restart. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

Returns
Type Description
ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.RestartRequest

Resume(ResumeConnectorRequest, string)

Resumes the connector and its tasks.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.ResumeRequest Resume(ResumeConnectorRequest body, string name)
Parameters
Type Name Description
ResumeConnectorRequest body

The body of the request.

string name

Required. The name of the connector to pause. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

Returns
Type Description
ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.ResumeRequest

Stop(StopConnectorRequest, string)

Stops the connector.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.StopRequest Stop(StopConnectorRequest body, string name)
Parameters
Type Name Description
StopConnectorRequest body

The body of the request.

string name

Required. The name of the connector to stop. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

Returns
Type Description
ProjectsResource.LocationsResource.ConnectClustersResource.ConnectorsResource.StopRequest
In this article
Back to top Generated by DocFX