Cloud Build API . projects . locations . gitLabConfigs

Instance Methods

connectedRepositories()

Returns the connectedRepositories Resource.

repos()

Returns the repos Resource.

close()

Close httplib2 connections.

create(parent, body=None, gitlabConfigId=None, x__xgafv=None)

Creates a new `GitLabConfig`. This API is experimental

delete(name, x__xgafv=None)

Delete a `GitLabConfig`. This API is experimental

get(name, x__xgafv=None)

Retrieves a `GitLabConfig`. This API is experimental

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

List all `GitLabConfigs` for a given project. This API is experimental

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an existing `GitLabConfig`. This API is experimental

removeGitLabConnectedRepository(config, body=None, x__xgafv=None)

Remove a GitLab repository from a given GitLabConfig's connected repositories. This API is experimental.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, gitlabConfigId=None, x__xgafv=None)
Creates a new `GitLabConfig`. This API is experimental

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

{ # GitLabConfig represents the configuration for a GitLab integration.
  "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config.
    { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise
      "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
      "webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
    },
  ],
  "createTime": "A String", # Output only. Time when the config was created.
  "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config.
    "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host.
    "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance.
      "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
    },
    "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances.
  },
  "name": "A String", # The resource name for the config.
  "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config.
    "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version
    "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build.
    "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version
    "webhookSecretVersion": "A String", # Required. Immutable. The resource name for the webhook secret’s secret version. Once this field has been set, it cannot be changed. If you need to change it, please create another GitLabConfig.
  },
  "username": "A String", # Username of the GitLab.com or GitLab Enterprise account Cloud Build will use.
  "webhookKey": "A String", # Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config.
}

  gitlabConfigId: string, Optional. The ID to use for the GitLabConfig, which will become the final component of the GitLabConfig’s resource name. gitlab_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character
  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, x__xgafv=None)
Delete a `GitLabConfig`. This API is experimental

Args:
  name: string, Required. The config resource name. (required)
  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.
  },
}
get(name, x__xgafv=None)
Retrieves a `GitLabConfig`. This API is experimental

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

Returns:
  An object of the form:

    { # GitLabConfig represents the configuration for a GitLab integration.
  "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config.
    { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise
      "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
      "webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
    },
  ],
  "createTime": "A String", # Output only. Time when the config was created.
  "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config.
    "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host.
    "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance.
      "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
    },
    "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances.
  },
  "name": "A String", # The resource name for the config.
  "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config.
    "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version
    "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build.
    "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version
    "webhookSecretVersion": "A String", # Required. Immutable. The resource name for the webhook secret’s secret version. Once this field has been set, it cannot be changed. If you need to change it, please create another GitLabConfig.
  },
  "username": "A String", # Username of the GitLab.com or GitLab Enterprise account Cloud Build will use.
  "webhookKey": "A String", # Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all `GitLabConfigs` for a given project. This API is experimental

Args:
  parent: string, Required. Name of the parent resource (required)
  pageSize: integer, The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 50 configs will be returned. The maximum value is 1000;, values above 1000 will be coerced to 1000.
  pageToken: string, A page token, received from a previous ‘ListGitlabConfigsRequest’ call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ‘ListGitlabConfigsRequest’ must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # RPC response object returned by ListGitLabConfigs RPC method.
  "gitlabConfigs": [ # A list of GitLabConfigs
    { # GitLabConfig represents the configuration for a GitLab integration.
      "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config.
        { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise
          "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
          "webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
        },
      ],
      "createTime": "A String", # Output only. Time when the config was created.
      "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config.
        "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host.
        "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance.
          "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
        },
        "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances.
      },
      "name": "A String", # The resource name for the config.
      "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config.
        "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version
        "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build.
        "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version
        "webhookSecretVersion": "A String", # Required. Immutable. The resource name for the webhook secret’s secret version. Once this field has been set, it cannot be changed. If you need to change it, please create another GitLabConfig.
      },
      "username": "A String", # Username of the GitLab.com or GitLab Enterprise account Cloud Build will use.
      "webhookKey": "A String", # Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config.
    },
  ],
  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page If this field is omitted, there are no subsequent pages.
}
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.
        
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an existing `GitLabConfig`. This API is experimental

Args:
  name: string, The resource name for the config. (required)
  body: object, The request body.
    The object takes the form of:

{ # GitLabConfig represents the configuration for a GitLab integration.
  "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config.
    { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise
      "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
      "webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
    },
  ],
  "createTime": "A String", # Output only. Time when the config was created.
  "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config.
    "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host.
    "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance.
      "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
    },
    "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances.
  },
  "name": "A String", # The resource name for the config.
  "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config.
    "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version
    "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build.
    "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version
    "webhookSecretVersion": "A String", # Required. Immutable. The resource name for the webhook secret’s secret version. Once this field has been set, it cannot be changed. If you need to change it, please create another GitLabConfig.
  },
  "username": "A String", # Username of the GitLab.com or GitLab Enterprise account Cloud Build will use.
  "webhookKey": "A String", # Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config.
}

  updateMask: string, Update mask for the resource. If this is set, the server will only update the fields specified in the field mask. Otherwise, a full update of the mutable resource fields will be performed.
  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.
  },
}
removeGitLabConnectedRepository(config, body=None, x__xgafv=None)
Remove a GitLab repository from a given GitLabConfig's connected repositories. This API is experimental.

Args:
  config: string, Required. The name of the `GitLabConfig` to remove a connected repository. Format: `projects/{project}/locations/{location}/gitLabConfigs/{config}` (required)
  body: object, The request body.
    The object takes the form of:

{ # RPC request object accepted by RemoveGitLabConnectedRepository RPC method.
  "connectedRepository": { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise # The connected repository to remove.
    "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
    "webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
  },
}

  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); }
}