Developer Connect API . projects . locations . connections . gitRepositoryLinks

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, gitRepositoryLinkId=None, requestId=None, validateOnly=None, x__xgafv=None)

Creates a GitRepositoryLink. Upon linking a Git Repository, Developer Connect will configure the Git Repository to send webhook events to Developer Connect. Connections that use Firebase GitHub Application will have events forwarded to the Firebase service. All other Connections will have events forwarded to Cloud Build.

delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)

Deletes a single GitRepositoryLink.

fetchGitRefs(gitRepositoryLink, pageSize=None, pageToken=None, refType=None, x__xgafv=None)

Fetch the list of branches or tags for a given repository.

fetchGitRefs_next()

Retrieves the next page of results.

fetchReadToken(gitRepositoryLink, body=None, x__xgafv=None)

Fetches read token of a given gitRepositoryLink.

fetchReadWriteToken(gitRepositoryLink, body=None, x__xgafv=None)

Fetches read/write token of a given gitRepositoryLink.

get(name, x__xgafv=None)

Gets details of a single GitRepositoryLink.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists GitRepositoryLinks in a given project, location, and connection.

list_next()

Retrieves the next page of results.

processGitLabEnterpriseWebhook(name, body=None, x__xgafv=None)

ProcessGitLabEnterpriseWebhook is called by the external GitLab Enterprise instances for notifying events.

processGitLabWebhook(name, body=None, x__xgafv=None)

ProcessGitLabWebhook is called by the GitLab.com for notifying events.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, gitRepositoryLinkId=None, requestId=None, validateOnly=None, x__xgafv=None)
Creates a GitRepositoryLink. Upon linking a Git Repository, Developer Connect will configure the Git Repository to send webhook events to Developer Connect. Connections that use Firebase GitHub Application will have events forwarded to the Firebase service. All other Connections will have events forwarded to Cloud Build.

Args:
  parent: string, Required. Value for parent. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message describing the GitRepositoryLink object
  "annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
    "a_key": "A String",
  },
  "cloneUri": "A String", # Required. Git Clone URI.
  "createTime": "A String", # Output only. [Output only] Create timestamp
  "deleteTime": "A String", # Output only. [Output only] Delete timestamp
  "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  "labels": { # Optional. Labels as key value pairs
    "a_key": "A String",
  },
  "name": "A String", # Identifier. Resource name of the repository, in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.
  "reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
  "uid": "A String", # Output only. A system-assigned unique identifier for the GitRepositoryLink.
  "updateTime": "A String", # Output only. [Output only] Update timestamp
  "webhookId": "A String", # Output only. External ID of the webhook created for the repository.
}

  gitRepositoryLinkId: string, Required. The ID to use for the repository, which will become the final component of the repository's resource name. This ID should be unique in the connection. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@.
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  validateOnly: boolean, Optional. If set, validate the request, but do not actually post it.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)
Deletes a single GitRepositoryLink.

Args:
  name: string, Required. Name of the resource (required)
  etag: string, Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  validateOnly: boolean, Optional. If set, validate the request, but do not actually post it.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
fetchGitRefs(gitRepositoryLink, pageSize=None, pageToken=None, refType=None, x__xgafv=None)
Fetch the list of branches or tags for a given repository.

Args:
  gitRepositoryLink: string, Required. The resource name of GitRepositoryLink in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
  pageSize: integer, Optional. Number of results to return in the list. Default to 20.
  pageToken: string, Optional. Page start.
  refType: string, Required. Type of refs to fetch.
    Allowed values
      REF_TYPE_UNSPECIFIED - No type specified.
      TAG - To fetch tags.
      BRANCH - To fetch branches.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for fetching git refs.
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "refNames": [ # Name of the refs fetched.
    "A String",
  ],
}
fetchGitRefs_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
fetchReadToken(gitRepositoryLink, body=None, x__xgafv=None)
Fetches read token of a given gitRepositoryLink.

Args:
  gitRepositoryLink: string, Required. The resource name of the gitRepositoryLink in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for fetching SCM read token.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for responding to get read token.
  "expirationTime": "A String", # Expiration timestamp. Can be empty if unknown or non-expiring.
  "gitUsername": "A String", # The git_username to specify when making a git clone with the token. For example, for GitHub GitRepositoryLinks, this would be "x-access-token"
  "token": "A String", # The token content.
}
fetchReadWriteToken(gitRepositoryLink, body=None, x__xgafv=None)
Fetches read/write token of a given gitRepositoryLink.

Args:
  gitRepositoryLink: string, Required. The resource name of the gitRepositoryLink in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for fetching SCM read/write token.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for responding to get read/write token.
  "expirationTime": "A String", # Expiration timestamp. Can be empty if unknown or non-expiring.
  "gitUsername": "A String", # The git_username to specify when making a git clone with the token. For example, for GitHub GitRepositoryLinks, this would be "x-access-token"
  "token": "A String", # The token content.
}
get(name, x__xgafv=None)
Gets details of a single GitRepositoryLink.

Args:
  name: string, Required. Name of the resource (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing the GitRepositoryLink object
  "annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
    "a_key": "A String",
  },
  "cloneUri": "A String", # Required. Git Clone URI.
  "createTime": "A String", # Output only. [Output only] Create timestamp
  "deleteTime": "A String", # Output only. [Output only] Delete timestamp
  "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  "labels": { # Optional. Labels as key value pairs
    "a_key": "A String",
  },
  "name": "A String", # Identifier. Resource name of the repository, in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.
  "reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
  "uid": "A String", # Output only. A system-assigned unique identifier for the GitRepositoryLink.
  "updateTime": "A String", # Output only. [Output only] Update timestamp
  "webhookId": "A String", # Output only. External ID of the webhook created for the repository.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists GitRepositoryLinks in a given project, location, and connection.

Args:
  parent: string, Required. Parent value for ListGitRepositoryLinksRequest (required)
  filter: string, Optional. Filtering results
  orderBy: string, Optional. Hint for how to order the results
  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, Optional. A token identifying a page of results the server should return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing GitRepositoryLinks
  "gitRepositoryLinks": [ # The list of GitRepositoryLinks
    { # Message describing the GitRepositoryLink object
      "annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
        "a_key": "A String",
      },
      "cloneUri": "A String", # Required. Git Clone URI.
      "createTime": "A String", # Output only. [Output only] Create timestamp
      "deleteTime": "A String", # Output only. [Output only] Delete timestamp
      "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
      "labels": { # Optional. Labels as key value pairs
        "a_key": "A String",
      },
      "name": "A String", # Identifier. Resource name of the repository, in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.
      "reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
      "uid": "A String", # Output only. A system-assigned unique identifier for the GitRepositoryLink.
      "updateTime": "A String", # Output only. [Output only] Update timestamp
      "webhookId": "A String", # Output only. External ID of the webhook created for the repository.
    },
  ],
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
processGitLabEnterpriseWebhook(name, body=None, x__xgafv=None)
ProcessGitLabEnterpriseWebhook is called by the external GitLab Enterprise instances for notifying events.

Args:
  name: string, Required. The GitRepositoryLink resource where the webhook will be received. Format: `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # RPC request object accepted by the ProcessGitLabEnterpriseWebhook RPC method.
  "body": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Required. HTTP request body.
    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
    "data": "A String", # The HTTP request/response body as raw binary.
    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
processGitLabWebhook(name, body=None, x__xgafv=None)
ProcessGitLabWebhook is called by the GitLab.com for notifying events.

Args:
  name: string, Required. The GitRepositoryLink resource where the webhook will be received. Format: `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # RPC request object accepted by the ProcessGitLabWebhook RPC method.
  "body": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Required. HTTP request body.
    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
    "data": "A String", # The HTTP request/response body as raw binary.
    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}