Class BillingAccount.Builder (2.55.0)

public static final class BillingAccount.Builder extends GeneratedMessageV3.Builder<BillingAccount.Builder> implements BillingAccountOrBuilder

A billing account in the Google Cloud Console. You can assign a billing account to one or more projects.

Protobuf type google.cloud.billing.v1.BillingAccount

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BillingAccount.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BillingAccount.Builder
Overrides

build()

public BillingAccount build()
Returns
Type Description
BillingAccount

buildPartial()

public BillingAccount buildPartial()
Returns
Type Description
BillingAccount

clear()

public BillingAccount.Builder clear()
Returns
Type Description
BillingAccount.Builder
Overrides

clearCurrencyCode()

public BillingAccount.Builder clearCurrencyCode()

Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as USD.

Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.

string currency_code = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

clearDisplayName()

public BillingAccount.Builder clearDisplayName()

The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.

string display_name = 3;

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BillingAccount.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BillingAccount.Builder
Overrides

clearMasterBillingAccount()

public BillingAccount.Builder clearMasterBillingAccount()

If this account is a subaccount, then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.

string master_billing_account = 4;

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

clearName()

public BillingAccount.Builder clearName()

Output only. The resource name of the billing account. The resource name has the form billingAccounts/{billing_account_id}. For example, billingAccounts/012345-567890-ABCDEF would be the resource name for billing account 012345-567890-ABCDEF.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BillingAccount.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BillingAccount.Builder
Overrides

clearOpen()

public BillingAccount.Builder clearOpen()

Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it are unable to use paid services.

bool open = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

clearParent()

public BillingAccount.Builder clearParent()

Output only. The billing account's parent resource identifier. Use the MoveBillingAccount method to update the account's parent resource if it is a organization. Format:

  • organizations/{organization_id}, for example, organizations/12345678
  • billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

string parent = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

clone()

public BillingAccount.Builder clone()
Returns
Type Description
BillingAccount.Builder
Overrides

getCurrencyCode()

public String getCurrencyCode()

Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as USD.

Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.

string currency_code = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public ByteString getCurrencyCodeBytes()

Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as USD.

Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.

string currency_code = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for currencyCode.

getDefaultInstanceForType()

public BillingAccount getDefaultInstanceForType()
Returns
Type Description
BillingAccount

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.

string display_name = 3;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.

string display_name = 3;

Returns
Type Description
ByteString

The bytes for displayName.

getMasterBillingAccount()

public String getMasterBillingAccount()

If this account is a subaccount, then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.

string master_billing_account = 4;

Returns
Type Description
String

The masterBillingAccount.

getMasterBillingAccountBytes()

public ByteString getMasterBillingAccountBytes()

If this account is a subaccount, then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.

string master_billing_account = 4;

Returns
Type Description
ByteString

The bytes for masterBillingAccount.

getName()

public String getName()

Output only. The resource name of the billing account. The resource name has the form billingAccounts/{billing_account_id}. For example, billingAccounts/012345-567890-ABCDEF would be the resource name for billing account 012345-567890-ABCDEF.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the billing account. The resource name has the form billingAccounts/{billing_account_id}. For example, billingAccounts/012345-567890-ABCDEF would be the resource name for billing account 012345-567890-ABCDEF.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getOpen()

public boolean getOpen()

Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it are unable to use paid services.

bool open = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The open.

getParent()

public String getParent()

Output only. The billing account's parent resource identifier. Use the MoveBillingAccount method to update the account's parent resource if it is a organization. Format:

  • organizations/{organization_id}, for example, organizations/12345678
  • billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

string parent = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Output only. The billing account's parent resource identifier. Use the MoveBillingAccount method to update the account's parent resource if it is a organization. Format:

  • organizations/{organization_id}, for example, organizations/12345678
  • billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

string parent = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BillingAccount other)

public BillingAccount.Builder mergeFrom(BillingAccount other)
Parameter
Name Description
other BillingAccount
Returns
Type Description
BillingAccount.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BillingAccount.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BillingAccount.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BillingAccount.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BillingAccount.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BillingAccount.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BillingAccount.Builder
Overrides

setCurrencyCode(String value)

public BillingAccount.Builder setCurrencyCode(String value)

Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as USD.

Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.

string currency_code = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The currencyCode to set.

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

setCurrencyCodeBytes(ByteString value)

public BillingAccount.Builder setCurrencyCodeBytes(ByteString value)

Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as USD.

Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.

string currency_code = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for currencyCode to set.

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

setDisplayName(String value)

public BillingAccount.Builder setDisplayName(String value)

The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.

string display_name = 3;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public BillingAccount.Builder setDisplayNameBytes(ByteString value)

The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.

string display_name = 3;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BillingAccount.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BillingAccount.Builder
Overrides

setMasterBillingAccount(String value)

public BillingAccount.Builder setMasterBillingAccount(String value)

If this account is a subaccount, then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.

string master_billing_account = 4;

Parameter
Name Description
value String

The masterBillingAccount to set.

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

setMasterBillingAccountBytes(ByteString value)

public BillingAccount.Builder setMasterBillingAccountBytes(ByteString value)

If this account is a subaccount, then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.

string master_billing_account = 4;

Parameter
Name Description
value ByteString

The bytes for masterBillingAccount to set.

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

setName(String value)

public BillingAccount.Builder setName(String value)

Output only. The resource name of the billing account. The resource name has the form billingAccounts/{billing_account_id}. For example, billingAccounts/012345-567890-ABCDEF would be the resource name for billing account 012345-567890-ABCDEF.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

setNameBytes(ByteString value)

public BillingAccount.Builder setNameBytes(ByteString value)

Output only. The resource name of the billing account. The resource name has the form billingAccounts/{billing_account_id}. For example, billingAccounts/012345-567890-ABCDEF would be the resource name for billing account 012345-567890-ABCDEF.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

setOpen(boolean value)

public BillingAccount.Builder setOpen(boolean value)

Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it are unable to use paid services.

bool open = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The open to set.

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

setParent(String value)

public BillingAccount.Builder setParent(String value)

Output only. The billing account's parent resource identifier. Use the MoveBillingAccount method to update the account's parent resource if it is a organization. Format:

  • organizations/{organization_id}, for example, organizations/12345678
  • billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

string parent = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

setParentBytes(ByteString value)

public BillingAccount.Builder setParentBytes(ByteString value)

Output only. The billing account's parent resource identifier. Use the MoveBillingAccount method to update the account's parent resource if it is a organization. Format:

  • organizations/{organization_id}, for example, organizations/12345678
  • billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

string parent = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
BillingAccount.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BillingAccount.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BillingAccount.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final BillingAccount.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BillingAccount.Builder
Overrides