close()

Close httplib2 connections.

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

CreateBranchRule creates a branch rule in a given repository.

Args:
parent: string, A parameter (required)
body: object, The request body.
The object takes the form of:

{ # Metadata of a BranchRule. BranchRule is the protection rule to enforce pre-defined rules on designated branches within a repository.
"allowStaleReviews": True or False, # Optional. Determines if allow stale reviews or approvals before merging to the branch.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"createTime": "A String", # Output only. Create timestamp.
"disabled": True or False, # Optional. Determines if the branch rule is disabled or not.
"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.
"includePattern": "A String", # Optional. The pattern of the branch that can match to this BranchRule. Specified as regex. .* for all branches. Examples: main, (main|release.*). Current MVP phase only support `.*` for wildcard.
"minimumApprovalsCount": 42, # Optional. The minimum number of approvals required for the branch rule to be matched.
"minimumReviewsCount": 42, # Optional. The minimum number of reviews required for the branch rule to be matched.
"name": "A String", # Optional. A unique identifier for a BranchRule. The name should be of the format: `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}`
"requireCommentsResolved": True or False, # Optional. Determines if require comments resolved before merging to the branch.
"requireLinearHistory": True or False, # Optional. Determines if require linear history before merging to the branch.
"requirePullRequest": True or False, # Optional. Determines if the branch rule requires a pull request or not.
"requiredStatusChecks": [ # Optional. List of required status checks before merging to the branch.
{ # Check is a type for status check.
"context": "A String", # Required. The context of the check.
},
],
"uid": "A String", # Output only. Unique identifier of the repository.
"updateTime": "A String", # Output only. Update timestamp.
}

branchRuleId: string, A parameter
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, allowMissing=None, x__xgafv=None)

DeleteBranchRule deletes a branch rule.

Args:
name: string, A parameter (required)
allowMissing: boolean, Optional. If set to true, and the branch rule is not found, the request will succeed but no action will be taken on the server.
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)

GetBranchRule gets a branch rule.

Args:
  name: string, Required. Name of the repository to retrieve. The format is `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metadata of a BranchRule. BranchRule is the protection rule to enforce pre-defined rules on designated branches within a repository.
  "allowStaleReviews": True or False, # Optional. Determines if allow stale reviews or approvals before merging to the branch.
  "annotations": { # Optional. User annotations. These attributes can only be set and used by the user. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
    "a_key": "A String",
  },
  "createTime": "A String", # Output only. Create timestamp.
  "disabled": True or False, # Optional. Determines if the branch rule is disabled or not.
  "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.
  "includePattern": "A String", # Optional. The pattern of the branch that can match to this BranchRule. Specified as regex. .* for all branches. Examples: main, (main|release.*). Current MVP phase only support `.*` for wildcard.
  "minimumApprovalsCount": 42, # Optional. The minimum number of approvals required for the branch rule to be matched.
  "minimumReviewsCount": 42, # Optional. The minimum number of reviews required for the branch rule to be matched.
  "name": "A String", # Optional. A unique identifier for a BranchRule. The name should be of the format: `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}`
  "requireCommentsResolved": True or False, # Optional. Determines if require comments resolved before merging to the branch.
  "requireLinearHistory": True or False, # Optional. Determines if require linear history before merging to the branch.
  "requirePullRequest": True or False, # Optional. Determines if the branch rule requires a pull request or not.
  "requiredStatusChecks": [ # Optional. List of required status checks before merging to the branch.
    { # Check is a type for status check.
      "context": "A String", # Required. The context of the check.
    },
  ],
  "uid": "A String", # Output only. Unique identifier of the repository.
  "updateTime": "A String", # Output only. Update timestamp.
}

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

ListBranchRules lists branch rules in a given repository.

Args:
  parent: string, A parameter (required)
  pageSize: integer, A parameter
  pageToken: string, A parameter
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # ListBranchRulesResponse is the response to listing branchRules.
  "branchRules": [ # The list of branch rules.
    { # Metadata of a BranchRule. BranchRule is the protection rule to enforce pre-defined rules on designated branches within a repository.
      "allowStaleReviews": True or False, # Optional. Determines if allow stale reviews or approvals before merging to the branch.
      "annotations": { # Optional. User annotations. These attributes can only be set and used by the user. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
        "a_key": "A String",
      },
      "createTime": "A String", # Output only. Create timestamp.
      "disabled": True or False, # Optional. Determines if the branch rule is disabled or not.
      "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.
      "includePattern": "A String", # Optional. The pattern of the branch that can match to this BranchRule. Specified as regex. .* for all branches. Examples: main, (main|release.*). Current MVP phase only support `.*` for wildcard.
      "minimumApprovalsCount": 42, # Optional. The minimum number of approvals required for the branch rule to be matched.
      "minimumReviewsCount": 42, # Optional. The minimum number of reviews required for the branch rule to be matched.
      "name": "A String", # Optional. A unique identifier for a BranchRule. The name should be of the format: `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}`
      "requireCommentsResolved": True or False, # Optional. Determines if require comments resolved before merging to the branch.
      "requireLinearHistory": True or False, # Optional. Determines if require linear history before merging to the branch.
      "requirePullRequest": True or False, # Optional. Determines if the branch rule requires a pull request or not.
      "requiredStatusChecks": [ # Optional. List of required status checks before merging to the branch.
        { # Check is a type for status check.
          "context": "A String", # Required. The context of the check.
        },
      ],
      "uid": "A String", # Output only. Unique identifier of the repository.
      "updateTime": "A String", # Output only. Update timestamp.
    },
  ],
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
}

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, validateOnly=None, x__xgafv=None)

UpdateBranchRule updates a branch rule.

Args:
name: string, Optional. A unique identifier for a BranchRule. The name should be of the format: `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}` (required)
body: object, The request body.
The object takes the form of:

{ # Metadata of a BranchRule. BranchRule is the protection rule to enforce pre-defined rules on designated branches within a repository.
"allowStaleReviews": True or False, # Optional. Determines if allow stale reviews or approvals before merging to the branch.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"createTime": "A String", # Output only. Create timestamp.
"disabled": True or False, # Optional. Determines if the branch rule is disabled or not.
"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.
"includePattern": "A String", # Optional. The pattern of the branch that can match to this BranchRule. Specified as regex. .* for all branches. Examples: main, (main|release.*). Current MVP phase only support `.*` for wildcard.
"minimumApprovalsCount": 42, # Optional. The minimum number of approvals required for the branch rule to be matched.
"minimumReviewsCount": 42, # Optional. The minimum number of reviews required for the branch rule to be matched.
"name": "A String", # Optional. A unique identifier for a BranchRule. The name should be of the format: `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}`
"requireCommentsResolved": True or False, # Optional. Determines if require comments resolved before merging to the branch.
"requireLinearHistory": True or False, # Optional. Determines if require linear history before merging to the branch.
"requirePullRequest": True or False, # Optional. Determines if the branch rule requires a pull request or not.
"requiredStatusChecks": [ # Optional. List of required status checks before merging to the branch.
{ # Check is a type for status check.
"context": "A String", # Required. The context of the check.
},
],
"uid": "A String", # Output only. Unique identifier of the repository.
"updateTime": "A String", # Output only. Update timestamp.
}

updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the branchRule resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The special value "*" means full replacement.
validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not actually post it. (https://google.aip.dev/163, for declarative friendly)
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.
},
}

Secure Source Manager API . projects . locations . repositories . branchRules

Instance Methods

Method Details